Skip to content

Commit b97f5e9

Browse files
committed
Update README with detailed development instructions
1 parent 5207a56 commit b97f5e9

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,20 @@ For more API details, please refer to the [TapPay Backend API Documentation](htt
8787

8888
### Setup
8989

90+
1. Clone the repository:
91+
9092
```bash
9193
git clone https://github.com/shihweilo/tappay-python.git
9294
cd tappay-python
93-
pip install -e ".[dev]"
95+
```
96+
97+
2. Create a virtual environment and install dependencies:
98+
99+
```bash
100+
python3 -m venv .venv
101+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
102+
pip install -e .
103+
pip install pytest pytest-cov ruff
94104
```
95105

96106
### Testing
@@ -101,6 +111,26 @@ Run tests using pytest:
101111
pytest
102112
```
103113

114+
Run tests with coverage:
115+
116+
```bash
117+
pytest --cov=tappay
118+
```
119+
120+
### Linting and Formatting
121+
122+
Check code with ruff:
123+
124+
```bash
125+
ruff check .
126+
```
127+
128+
Format code with ruff:
129+
130+
```bash
131+
ruff format .
132+
```
133+
104134
## Contributing
105135

106136
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)