Pattern-recognition

The command-line interface (CLI) that provides a set of commands to interact with the server and recognize the pattern.

• Getting started
• Usage
  • Service
• Development
• Production

Getting started

Blank.

Usage

Service

Get the version of the package — pattern-recognition --version:

$ pattern-recognition --version
pattern-recognition, version 0.1.0

Get all possible package's commands — pattern-recognition --help:

$ pattern-recognition --help
Usage: pattern-recognition [OPTIONS] COMMAND [ARGS]...
  Command line interface for PyPi version checking.
Options:
  --version  Show the version and exit.
  --help     Show this message and exit.
...

Development

To run the tests, use the following command, being in the root of the project:

$ pytest tests/

To build the package to test of to be deployed, use the following commands:

$ pip3 uninstall -y pattern-recognition-cli && rm -rf dist/ pattern-recognition-cli.egg-info && \
      python3 setup.py sdist && pip3 install dist/*.tar.gz

Production

To build the package and upload it to PypI to be accessible through pip, use the following commands. Twine requires the username and password of the account package is going to be uploaded to.

$ python3 setup.py sdist
$ twine upload dist/*