A meeting scheduler developed by Team Volleyball
Project description
Volleyball Meeting Scheduler
A command-line tool for scheduling volleyball-related meetings. This project is built with Python and uses Poetry for dependency management.
Table of Contents
1 User
1.1 Requirements
- Python 3.8+
- MySQL (local installation)
1.2 Features
- Schedule and manage meetings.
- Simple CLI interface for creating, reading, updating, and deleting meetings.
- Integrates with a MySQL database for persistent storage.
1.3 Installation
User installation instructions go here.
2 Developer
2.1 Requirements
- Python 3.8+
- Poetry
- MySQL (local installation)
2.2 Installation
To get started with development, follow the instructions below to set up the project on your local machine.
-
Clone the repository:
git clone https://github.com/Jython1415/cli-monolithic-architecture.git volleymeet cd volleymeet
-
Install Poetry (if you don’t already have it):
-
Create a virtual environment and install dependencies: Poetry will automatically create a virtual environment for the project.
poetry install poetry shell
-
Run the project:
poetry run volleyball-meetings
2.3 Testing
We use pytest
for testing the project. To run the test suite:
-
Run all tests:
poetry run pytest
-
View coverage: You can also generate a test coverage report:
poetry run pytest --cov=src
2.4 Contribution Guidelines
Always either use a branch or a fork for changes.
2.5 Build and Publish
To release a new version of the project, follow these steps:
-
Update the Version
Bump the version in pyproject.toml using Poetry's versioning command.
poetry version <major|minor|patch>
-
Update the Changelog
Document new features, fixes, or changes in CHANGELOG.md.
-
Commit Changes
Commit on bump and changelog update.
-
Tag the Release
git tag v<x.y.z> git push origin main --tags
-
Build the Package
poetry build
-
Publish to PyPI
poetry publish --build
3 License
This project is licensed under the MIT License. See the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for volleymeet-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc04de8a081acfe726fef9794d36f9d1732baee83831908840abdc275ff0ee89 |
|
MD5 | 1320901618af2bc6ac5a86262e9f7dea |
|
BLAKE2b-256 | 137c3ec11af049e4e45b4c0a9764204f52cc96cfedf6bed5ed04fb35c313f2fb |