Skip to content

Commit 59c12cc

Browse files
committed
Add .env example to ease the life of developers
1 parent adc5906 commit 59c12cc

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

.env.example

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
PYTHONPATH=${PWD}/src
2+
PATH=${PWD}/src/bin:${PATH}
3+
QFIELDCLOUD_URL=https://localhost:8002/api/v1/
4+
QFIELDCLOUD_VERIFY_SSL=0

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ dist
22
build
33
**/__pycache__
44
**/qfieldcloud_sdk.egg-info
5+
.env

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,15 +268,19 @@ cd qfieldcloud-sdk-python
268268
# install dev dependencies
269269
python3 -m pip install pipenv
270270
pipenv install --dev
271-
pipenv shell
272-
pipenv install -e . --dev
273271
pre-commit install
274272
```
275273

276274
To run CLI interface for development purposes execute:
277275

278276
```
279-
python src/bin/qfieldcloud-cli
277+
pipenv run python src/bin/qfieldcloud-cli
278+
```
279+
280+
To ease the development, you can set a `.env` file. Therefore you can use directly the `qfieldcloud-cli` executable:
281+
```
282+
cp .env.example .env
283+
pipenv run qfieldcloud-cli
280284
```
281285

282286
### Building the package

0 commit comments

Comments
 (0)