https://github.com/unfoldingword-dev/tx
The Door43 translationConverter
https://github.com/unfoldingword-dev/tx
converter ec2 tx
Last synced: about 1 month ago
JSON representation
The Door43 translationConverter
- Host: GitHub
- URL: https://github.com/unfoldingword-dev/tx
- Owner: unfoldingWord-dev
- License: mit
- Created: 2018-01-05T20:19:34.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-03T23:13:58.000Z (over 7 years ago)
- Last Synced: 2025-03-13T03:43:50.692Z (7 months ago)
- Topics: converter, ec2, tx
- Language: Python
- Homepage:
- Size: 23.7 MB
- Stars: 0
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# translationConverter (tx)
This tool provides a number of RESTful services for
processing and publishing translations on the [Door43 Content Service](https://git.door43.org).
# Development
All of the development commands have been place in a makefile for easy use.
* `make` or `make doc` generates the documentation.
* `make dependencies` install the dependencies.
* `make test` runs the tests.
* `make run` starts the development server.
## Contributing
When contributing please follow these practices:
* place new services under `./src/services/`.
* register your services in `./src/main.py` within the `register_services` function.
* add tests for your services in `./tests`.
# Documentation
Documentation is generated by [Sphinx](http://www.sphinx-doc.org) and is readable at [tx.readthedocs.io](http://tx.readthedocs.io/en/latest/index.html).
All methods and modules **must** be documented with reStructured text.
These doc strings will be used to generate the documentation files.
Everything under `./doc` has been configured for you or is managed by the makefile.
**Stay out of there!**
## Subpackages
If your service is prepared as a subpackage (directory) as opposed to a submodule (single file)
you must add a doc string to the subpackage's `__init__.py` file otherwise it will not
be added to the table of contents.