Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mathewkeeling/pymodl

Blending my passion for guitar with my desire to learn software development.
https://github.com/mathewkeeling/pymodl

Last synced: 21 days ago
JSON representation

Blending my passion for guitar with my desire to learn software development.

Awesome Lists containing this project

README

        






___ _ _
/ _ \_ _ /\/\ ___ __| | |
/ /_)/ | | |/ \ / _ \ / _` | |
/ ___/| |_| / /\/\ \ (_) | (_| | |
\/ \__, \/ \/\___/ \__,_|_|
|___/
v2024.10.30



PyModl



## Overview

**PyModl** (Pie-MOH-DUHL) is the result of the mixture of guitar and software. To run this project, download a copy of the repository and give a few of the Python files a play!

This application provides you with the tools to practice scales and study musical theory.

## Prerequisites

Before running the script, make sure you have the following:

- Python 3.x installed
- Git installed

## Installation

1. Clone the repository:
```bash
git clone https://github.com/MathewKeeling/PyModl.git
```
2. Navigate to the project directory:
```bash
cd pymodl
```
3. Install the required dependencies:
```bash
virtualenv venv
. ./venv/bin/activate
pip install pipenv
pipenv lock
pipenv install
```

## Usage

Run the main script to start the application:
```bash
python main.py
```

## Contributing

We welcome contributions! Please follow these guidelines:

- Use Black for code formatting.
- Ensure your code passes all tests.
- Submit pull requests (PRs) for any changes you make.
- Feel free to fork the repository and submit PRs.

## License

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