copapy/README.md

46 lines
880 B
Markdown
Raw Normal View History

2025-08-29 20:58:32 +00:00
# Copapy
2025-05-25 21:23:02 +00:00
## Installation
Installation with pip:
``` bash
2025-08-29 20:58:32 +00:00
pip install copapy
2025-05-25 21:23:02 +00:00
```
## Getting started
## Developer Guide
Contributions are welcome, please open an issue or submit a pull request on GitHub.
2025-08-29 20:58:32 +00:00
To get started with developing the `copapy` package, follow these steps.
2025-05-25 21:23:02 +00:00
First, clone the repository to your local machine using Git:
```bash
2025-08-29 20:58:32 +00:00
git clone https://github.com/nonannet/copapy.git
cd copapy
2025-05-25 21:23:02 +00:00
```
It's recommended to setup an venv:
```bash
2025-08-29 20:58:32 +00:00
python -m venv .venv
source .venv/bin/activate # On Windows use `.venv\Scripts\activate`
2025-05-25 21:23:02 +00:00
```
Install the package and dev-dependencies while keeping the package files
in the current directory:
```bash
pip install -e .[dev]
```
Ensure that everything is set up correctly by running the tests:
```bash
pytest
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.