volleymeet 0.2.0

A meeting scheduler developed by Team Volleyball

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
  • 1.2 Features
  • 1.3 Installation
• 2 Developer
  • 2.1 Requirements
  • 2.2 Installation
  • 2.3 Testing
  • 2.4 Contribution Guidelines
• 3 License

---

1 User

1.1 Requirements

• Python 3.8+

1.2 Features

• Schedule and manage meetings.
• Simple CLI interface for creating, reading, updating, and deleting meetings.

1.3 Installation

pip install volleymeet

2 Developer

2.1 Requirements

• Python 3.8+
• Poetry

2.2 Installation

To get started with development, follow the instructions below to set up the project on your local machine.

1. Clone the repository:

   git clone https://github.com/Jython1415/cli-monolithic-architecture.git volleymeet
   cd volleymeet
   

2. Install Poetry (if you don’t already have it):

3. Create a virtual environment and install dependencies: Poetry will automatically create a virtual environment for the project.

   poetry install
   poetry shell
   

4. Create the database:

   poetry run python database/db_setup.py
   

5. 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:

1. Update the Version

   Bump the version in pyproject.toml using Poetry's versioning command.

   poetry version <major|minor|patch>
   

2. Update the Changelog

   Document new features, fixes, or changes in CHANGELOG.md.

3. Commit Changes

   Commit on bump and changelog update.

4. Tag the Release

   git tag v<x.y.z>
   git push origin main --tags
   

5. Build the Package

   poetry build
   

6. Publish to PyPI

   poetry publish --build
   

3 License

This project is licensed under the MIT License. See the LICENSE file for details.