Skip to content

Commit

Permalink
docs: notes about test and lint
Browse files Browse the repository at this point in the history
  • Loading branch information
kmpm authored Jun 1, 2022
1 parent 0fc7604 commit be409ff
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,26 @@ python3 -m venv venv
pip install -e .[dev]
```

# Test
Before you commit any code you should preferably run...
```shell
make lint
make test
```

## Live Testing
If you have a domain to play around with there is a way of running a live test.
You must create the `credentials.ini` file in the project root with the correct credentials.
```shell
# set some variables that are used
export EMAIL=<your email address>
export TESTDOMAIN=<yourdomain.com>


# run the live tests that will be using your email and test.sub.$TESTDOMAIN
make livetest
```



# Publish
Expand Down Expand Up @@ -58,4 +78,4 @@ twine upload -r testpypi dist/*
# upload to production pypi, this will also require maintainer access
twine upload dist/*

```
```

0 comments on commit be409ff

Please sign in to comment.