File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing to Replane Python SDK
2+
3+ Thank you for your interest in contributing! This guide will help you get started.
4+
5+ ## Getting Started
6+
7+ ### Prerequisites
8+
9+ - ** Python** : Version 3.10 or greater
10+
11+ ### Clone the Repository
12+
13+ ``` sh
14+ git clone https://github.com/replane-dev/replane-python.git
15+ cd replane-python
16+ ```
17+
18+ ### Set Up Development Environment
19+
20+ Create and activate a virtual environment:
21+
22+ ``` sh
23+ python -m venv .venv
24+ source .venv/bin/activate # On Windows: .venv\Scripts\activate
25+ ```
26+
27+ Install the package in development mode with dev dependencies:
28+
29+ ``` sh
30+ pip install -e " .[dev]"
31+ ```
32+
33+ ## Development
34+
35+ ### Run Tests
36+
37+ ``` sh
38+ pytest
39+ ```
40+
41+ With coverage:
42+
43+ ``` sh
44+ pytest --cov=replane
45+ ```
46+
47+ ### Lint
48+
49+ ``` sh
50+ ruff check .
51+ ```
52+
53+ ### Type Check
54+
55+ ``` sh
56+ mypy replane
57+ ```
58+
59+ ### Format
60+
61+ ``` sh
62+ black .
63+ isort .
64+ ```
65+
66+ ## Pull Requests
67+
68+ 1 . Fork the repository
69+ 2 . Create a feature branch: ` git checkout -b feature/your-feature `
70+ 3 . Make your changes
71+ 4 . Ensure tests pass: ` pytest `
72+ 5 . Ensure linting passes: ` ruff check . `
73+ 6 . Ensure type checking passes: ` mypy replane `
74+ 7 . Commit your changes with a descriptive message
75+ 8 . Push to your fork and submit a pull request
76+
77+ ## Reporting Issues
78+
79+ Found a bug or have a feature request? Please open an issue on GitHub.
80+
81+ ## Community
82+
83+ Have questions or want to discuss Replane? Join the conversation in [ GitHub Discussions] ( https://github.com/orgs/replane-dev/discussions ) .
84+
85+ ## License
86+
87+ By contributing to Replane Python SDK, you agree that your contributions will be licensed under the MIT License.
Original file line number Diff line number Diff line change 22
33Python SDK for [ Replane] ( https://replane.dev ) - a dynamic configuration platform with real-time updates.
44
5- [ ![ Documentation] ( https://img.shields.io/badge/docs-readthedocs-blue )] ( https://replane.readthedocs.io/en/latest/ )
6-
7- ** [ Full Documentation] ( https://replane.readthedocs.io/en/latest/ ) **
5+ [ ![ PyPI] ( https://img.shields.io/pypi/v/replane )] ( https://pypi.org/project/replane/ )
6+ [ ![ CI] ( https://github.com/replane-dev/replane-python/actions/workflows/ci.yml/badge.svg )] ( https://github.com/replane-dev/replane-python/actions )
7+ [ ![ License] ( https://img.shields.io/github/license/replane-dev/replane-python )] ( https://github.com/replane-dev/replane-python/blob/main/LICENSE )
8+ [ ![ Community] ( https://img.shields.io/badge/discussions-join-blue?logo=github )] ( https://github.com/orgs/replane-dev/discussions )
89
910## Features
1011
@@ -326,6 +327,10 @@ def get_items():
326327- No dependencies for sync client
327328- ` httpx ` for async client (` pip install replane[async] ` )
328329
330+ ## Contributing
331+
332+ See [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for development setup and contribution guidelines.
333+
329334## Community
330335
331336Have questions or want to discuss Replane? Join the conversation in [ GitHub Discussions] ( https://github.com/orgs/replane-dev/discussions ) .
You can’t perform that action at this time.
0 commit comments