https://github.com/vyahello/rent-electro-scooter
🛴 CLI application for renting electro-scooters (python + sqlalchemy orm + travis CI)
https://github.com/vyahello/rent-electro-scooter
cli-application renting-electro-scooters scooter sqlalchemy
Last synced: 7 months ago
JSON representation
🛴 CLI application for renting electro-scooters (python + sqlalchemy orm + travis CI)
- Host: GitHub
- URL: https://github.com/vyahello/rent-electro-scooter
- Owner: vyahello
- License: mit
- Created: 2020-01-26T13:24:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T15:31:48.000Z (about 2 years ago)
- Last Synced: 2025-08-03T04:33:02.411Z (10 months ago)
- Topics: cli-application, renting-electro-scooters, scooter, sqlalchemy
- Language: Python
- Homepage: https://vyahello.github.io/rent-electro-scooter
- Size: 17.2 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
[](https://www.python.org/)
[](https://github.com/psf/black)
[](https://travis-ci.org/vyahello/rent-electro-scooter)
[](LICENSE.md)
[](https://pypi.org/project/scooter-rental/)
[](https://pypi.org/project/scooter-rental/)
[](https://pypi.python.org/pypi/scooter-rental)
[](https://pepy.tech/project/scooter-rental)
# 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
### Production
- python 3.6, 3.7, 3.8
- [sqlalchemy](https://www.sqlalchemy.org) database
- [alembic](https://alembic.sqlalchemy.org/en/latest/) database migration
### Development
- [pytest](https://pypi.org/project/pytest/)
- [black](https://black.readthedocs.io/en/stable/)
- [pylint](https://www.pylint.org/)
- [flake8](http://flake8.pycqa.org/en/latest/)
## Usage
### Installation
Please run following script to obtain latest package from PYPI:
```bash
pip install scooter-rental
```
Then please launch following tool from your environment:
```bash
scooter-rental
```
### Source code
To be able to run source code please execute command below:
```bash
git@github.com:vyahello/rent-electro-scooter.git
python -m scooter
```
## Development notes
### Database migration
For database migrations [alembic](https://alembic.sqlalchemy.org/en/latest/) package is used. Please follow [alembic.ini](alembic.ini) file for instructions.
Once new changes were made to the database, please follow instructions below:
```bash
alembic revision --autogenerate -m "commit message"
alembic upgrade head
alembic current
```
### CI
Project has Travis CI integration using [.travis.yml](.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:
```bash
./analyse-code.sh
```
### Release notes
Please check [changelog](CHANGELOG.md) file to get more details about actual versions and it's release notes.
### Meta
Author – _Volodymyr Yahello_
Distributed under the `MIT` license. See [LICENSE](LICENSE.md) for more information.
You can reach out me at:
* [vyahello@gmail.com](vyahello@gmail.com)
* [https://twitter.com/vyahello](https://twitter.com/vyahello)
* [https://www.linkedin.com/in/volodymyr-yahello-821746127](https://www.linkedin.com/in/volodymyr-yahello-821746127)
### 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
3. `pip install -r requirements-dev.txt` to install all development project dependencies