scooter-rental

A command line application for renting electro-scooters. Just try it, it is fun :)


Keywords
cli-application, sqlalchemy
License
GPL-3.0
Install
pip install scooter-rental==0.0.3

Documentation

made-with-python Code style: black Build Status Forks Stars License PyPI version shields.io PyPI pyversions Downloads

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

Usage

Demo

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:

Contributing

  1. clone the repository
  2. configure Git for the first time after cloning with your name and email
  3. pip install -r requirements.txt to install all project dependencies
  4. pip install -r requirements-dev.txt to install all development project dependencies