Commit 2412fe48 authored by Bram Daams's avatar Bram Daams
Browse files

release notes, readme

parent 348bd1f4
Pipeline #40871 passed with stage
in 36 seconds
......@@ -7,3 +7,11 @@
### release notes for 0.2.0
- changed file structure
- first release on PyPI.
### release notes for 0.2.3
- moved all code back into `sch.py`
- previous released packages where broken...
### release notes for 0.2.4
- updated release notes
- got rid of outdated development section in the readme
......@@ -108,39 +108,6 @@ For `sch` managed jobs:
- os.sytem executes the command
- depending on the exit code, it will ping for success or ping the `/fail` end point on failure
## Development environment
### Setup environment
``` console
$ python -m venv venv
$ . venv/bin/activate
$ pip install --editable .
```
### Testing
Create a file named `sch.conf` and edit the Healthchecks API URL and key:
``` console
cp sch.conf.example sch.conf
```
The configuration file looks like:
``` console
$ cat sch.conf.example
[hc]
healthchecks_api_url = https://hc.example.com/api/v1/
healthchecks_api_key = xxmysecretkeyxx
```
Create a test cron job:
``` console
$ sudo cp doc/testcrontab /etc/cron.d/test
$ ./testshell.sh
```
### Syntax check
Style Guide Enforcement:
``` console
$ pip install flake8
$ flake8 *py
```
### References
* python-crontab <https://pypi.org/project/python-crontab/>
* crab <https://github.com/grahambell/crab>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment