ivanhercaz / ivanhercaz/pysemanticmw
Release 1.0.0
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
This the roadmap for the release 1.0.0. There isn't any date to release. I will make each task when I have time, but anyone is welcome to collaborate ([just keep in mind this](https://github.com/ivanhercaz/pysemanticmw#note)).
- [ ] A Python module with the [special actions](https://github.com/SemanticMediaWiki/SemanticMediaWiki/blob/master/docs/technical/api.md) of Semantic MediaWiki API until before the version 3.0 to build your own scripts. These actions are:
- [ ] `ask` (#2)
- [ ] `askargs` (#3)
- [ ] `smwinfo`
- [ ] `browsebysubject`
- [ ] `browsebyproperty`.
- [ ] A command-line interface able to run the special actions mentioned above (#4).
- [ ] Specification of errors that could occur and how solve them.
- [ ] Documentation: docblocks in functions and comments in the code to explain it (yes, I like very much to explain the code to be easy to understand for anyone, due it has help me in the past and it could help other people).
- [ ] Test the command client and the module, and upload it to the Python Package Index (Pypi).
These are the characteristics that I consider essential to release a 1.0.0. I don't know if I will make more than there are in this list, but I don't expect to make less. If I finally add something more to this release, I will note in this roadmap.
Any idea is welcome! You can propose it in another issue to discuss about it.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the Semantic MediaWiki special-actions API specification linked in the roadmap, then review the separate issues for `ask` (#2), `askargs` (#3), and the command-line interface (#4). This roadmap is complete when the listed module, CLI, error specification, documentation, tests, and PyPI release tasks are finished.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100