https://github.com/maureen-keter/class-booking-cli
A CLI project to manage lecture halls
https://github.com/maureen-keter/class-booking-cli
alembic classes-and-objects migration python3 sqlalchemy sqlalchemy-orm
Last synced: 6 months ago
JSON representation
A CLI project to manage lecture halls
- Host: GitHub
- URL: https://github.com/maureen-keter/class-booking-cli
- Owner: Maureen-keter
- License: mit
- Created: 2023-12-14T01:13:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T07:54:50.000Z (about 2 years ago)
- Last Synced: 2025-06-09T21:07:49.247Z (7 months ago)
- Topics: alembic, classes-and-objects, migration, python3, sqlalchemy, sqlalchemy-orm
- Language: Python
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# class-booking-CLI
Class CLI is a command-line application designed to manage educational institutions, lecture halls, and lectures. It utilizes SQLAlchemy as an ORM (Object-Relational Mapping) tool for database interactions and Faker to generate realistic fake data for testing purposes.
## Table of Contents
1.Getting Started
2.Prerequisites
3.Installation
4.Usage
5.Run the Application
5.Database Migration
7.Contributing
8.License
## Getting Started
### Prerequisites
Ensure you have the following software installed:
- Python 3.x
### Installation
1. **Clone the repository:**
git clone https://github.com/your-username/class-cli.git
2. **Navigate to the project directory:**
cd class-cli
3. **Set up a virtual environment:**
pipenv install
pipenv shell
4. **Install dependencies:**
pip install -r requirements.txt
5. **Run the seed script to populate the database with fake data:**
python seed.py
## Usage
### Run the Application
1. **Ensure the virtual environment is activated :**
pipenv shell
## Database Migration
If changes are made to the models, perform a database migration using Alembic.
1. **Install Alembic:**
pip install alembic
2. **Create an Alembic migration:**
alembic init alembic
## Contributing
Contributions are welcome! If you find a bug or have an improvement suggestion, please open an issue or create a pull request.
## License
This project is licensed under the MIT License .
## Author
Maureen Chelangat.