Skip to content

Commit 39d6539

Browse files
committed
Refactor docs
1 parent 5ea1dee commit 39d6539

6 files changed

Lines changed: 329 additions & 314 deletions

File tree

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Contributing to vitallens-python
2+
3+
Thank you for your interest in contributing! This guide will help you set up your development environment and run the test suite.
4+
5+
## Development setup
6+
7+
We recommend using a virtual environment to manage dependencies.
8+
9+
### Clone and install
10+
11+
Clone the repository and install the package in **editable mode** with development dependencies.
12+
13+
```bash
14+
# Clone the repo
15+
git clone https://github.com/Rouast-Labs/vitallens-python.git
16+
cd vitallens-python
17+
18+
# Create a virtual environment
19+
python -m venv venv
20+
source venv/bin/activate
21+
22+
# Install in editable mode
23+
# This allows you to modify source code and see changes immediately.
24+
pip install -e .
25+
26+
# Install dev tools
27+
pip install flake8 pytest build
28+
```
29+
30+
## Running tests
31+
32+
The test suite requires a valid API Key to verify integration with the live API.
33+
34+
1. **Set the Environment Variable:**
35+
36+
You must set `VITALLENS_DEV_API_KEY` before running tests.
37+
38+
```bash
39+
# Mac/Linux
40+
export VITALLENS_DEV_API_KEY="your_api_key_here"
41+
42+
# Windows (PowerShell)
43+
$env:VITALLENS_DEV_API_KEY="your_api_key_here"
44+
```
45+
46+
2. **Run Pytest:**
47+
48+
```bash
49+
pytest
50+
```
51+
52+
## Linting
53+
54+
We use `flake8` to ensure code quality. Please check your code before submitting a PR.
55+
56+
```bash
57+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
58+
```
59+
60+
## Building the package
61+
62+
To build the distribution archives (source and wheel) for PyPI:
63+
64+
```bash
65+
python -m build
66+
```
67+
68+
The artifacts will be generated in the `dist/` directory.

0 commit comments

Comments
 (0)