Rent electro scooter
This is a regular CLI application for renting electro-scooters.
It uses SQLAlchemy API as a database core with ORM (Object Relational Mapper) support.
Tools
- python 3.6 | 3.7 | 3.8
- sqlalchemy database
- alembic database migration
- code analysis
Usage
Installation
Please run following script to obtain latest package from PYPI:
pip install scooter-rental
Then please launch following tool from your environment:
scooter-rental
Source code
To be able to run source code please execute command below:
git@github.com:vyahello/rent-electro-scooter.git
python -m scooter
Development notes
Database migration
For database migrations alembic package is used. Please follow alembic.ini file for instructions.
Once new changes were made to the database, please follow instructions below:
alembic revision --autogenerate -m "commit message"
alembic upgrade head
alembic current
CI
Project has Travis CI integration using .travis.yml file thus code analysis (black
, pylint
, flake8
) and unittests (pytest
) will be run automatically
after every made change to the repository.
To be able to run code analysis, please execute command below:
./analyse-code.sh
Release notes
Please check changelog file to get more details about actual versions and it's release notes.
Meta
Author – Volodymyr Yahello
Distributed under the MIT
license. See LICENSE for more information.
You can reach out me at:
- vyahello@gmail.com
- https://github.com/vyahello
- https://www.linkedin.com/in/volodymyr-yahello-821746127
Contributing
- clone the repository
- configure Git for the first time after cloning with your
name
andemail
-
pip install -r requirements.txt
to install all project dependencies -
pip install -r requirements-dev.txt
to install all development project dependencies