python-musicbrainz3: Difference between revisions
From MusicBrainz Wiki
Jump to navigationJump to search
(→Goals) |
|||
Line 22: | Line 22: | ||
# Set up project infrastructure |
# Set up project infrastructure |
||
## Wiki page ('''done''') |
## Wiki page ('''done''') |
||
## Git repository (Rob, '''in progress''') |
## Git repository (Rob/Oliver, '''in progress''') |
||
## Jira project? |
## Jira project? |
||
## Reviewboard? |
## Reviewboard? |
||
Line 28: | Line 28: | ||
## XML mapping tool (Matt, '''in progress''') |
## XML mapping tool (Matt, '''in progress''') |
||
## Unit test runner (nose?) |
## Unit test runner (nose?) |
||
# Create UML diagrams for |
|||
## the core entities |
|||
## pymb3's classes |
|||
# Set up project structure in the repository |
# Set up project structure in the repository |
||
# Gather data for the parser |
# Gather data for the parser |
Revision as of 22:03, 14 March 2010
The python-musicbrainz3 package is the successor of python-musicbrainz2.
NGS is coming, so a rewrite is in order to keep up with MB development. This wiki page collects information, plans, and ideas for this project.
Feel free to edit!
Goals
- Fully support the NGS data model and web service
- Require Python 2.6 and aim to be as close to Python 3 as possible
- Despite NGS's complexity: Simple things should be simple
- Turn today's modules into packages (source files are much too large)
- Make it more pythonic where possible (naming conventions?)
- Remove rarely used cruft (what would that be?)
- Keep the amount and quality of documentation
- Write more test cases
Project Plan
There are a few open tasks:
- Set up project infrastructure
- Wiki page (done)
- Git repository (Rob/Oliver, in progress)
- Jira project?
- Reviewboard?
- Evaluate tools
- XML mapping tool (Matt, in progress)
- Unit test runner (nose?)
- Create UML diagrams for
- the core entities
- pymb3's classes
- Set up project structure in the repository
- Gather data for the parser
- Update MMD Relax NG schema if necessary
- Prepare comprehensive set of example documents for the test suite
Links
Links with documentation and other relevant information.
- Matt's original blog announcement and mailing list archive
- Next Generation Schema Overview
- Web Service Interface
- Web Service XML Format
Project Infrastructure
- This wiki page is the central source of information
- Discussion can take place on the development mailing list
- Soon: git repository
- TODO: Review board?
- TODO: Jira?
Ideas and Open Questions
- Use an XML mapping package (xml.etree?)
- Import version history into git?