Tools for creating a dictionary of mnemonic substitutes
- Synopsis
- Prerequisites
- Downloading
- Installing
- Documentation
- Usage
- Development
- Deployments
- Testing
- Changelog
- License
- Authors
- Credits
You'll need to have Python 3 installed. The rest of the requirements should be handled by the installation script.
$ pip install -r requirements.txt
$ pip install setup.py
The documentation is in docs/source/index.rst. To create a more readable version, from a command prompt in the docs directory run the command make html. The start page for that documentation will be docs/build/html/index.html.
This project includes a number of helpers in the Makefile to streamline common development tasks.
The following demonstrates setting up and working with a development environment:
### create a virtualenv for development
$ make virtualenv
$ source env/bin/activate
### run mnempy cli application
$ mnempy --help
### run pytest / coverage
$ make test
Before releasing to PyPi, you must configure your login credentials:
~/.pypirc:
[pypi]
username = YOUR_USERNAME
password = YOUR_PASSWORD
Then use the included helper function via the Makefile:
$ make dist
$ make dist-upload
Included is a basic Dockerfile for building and distributing Mnempy,
and can be built with the included make helper:
$ make docker
$ docker run -it mnempy --help
From a command prompt in the project directory, run the command pytest to automatically run all the tests.
This project uses the MIT license. See the file LICENSE.md for details.
- Andy Culbertson (thinkulum@gmail.com) - original author
This package was created with Cement.