Slicr is a modular api designed to provide link management services including shortening and analytics.
To install the minimum version of this project run the following from the root directory:
make install
To install the development version of the api run:
make install-dev
To run the development server you can use the cli that comes with the package. This cli inherits all methods available through Flask. To install via Docker run:
make docker-build && make docker-rin
Testing in this package uses pytest as the default test runner. The tests in this packages are available in the test directory being split between unit and integration tests.
All tests can run through the following command:
make test
Coverage reports can be generated through:
make coverage
Linting is accomplished through pylint with the following configuration. Package source code can be linted by running:
make lint
- flask - Web framework
- SQLAlchemy - Package ORM
- pylint - Linting
- pytest - Test management
- coverage - Code coverage
For available versioning, see the tags on this repository.
- Travis Byrum - Initial work
This project is licensed under the MIT License - see the LICENSE file for details
- Change salt