grzegorz-clients/README.md

41 lines
1.3 KiB
Markdown
Raw Normal View History

# Gregorz Clients
2018-03-02 18:09:04 +01:00
<img align="right" width="250" src="grzegorz_clients/res/logo.png">
2018-02-26 23:06:09 +01:00
A set of simple API endpoints and ready-to-go clients to interface with the [Grzegorz API](https://github.com/Programvareverkstedet/grzegorz)
#### Working clients:
* A webUI client made with REMI
#### Planned future clients:
* CLI client
* WebExtensions browser extension
2018-02-26 23:06:09 +01:00
## How to run this
First of we need to install any needed dependencies. If you want to, you may do so in a virtual environment.
To install the needed dependencies, run this with sufficient rights (as root?):
pip install -r requirements.txt
Now, make a copy of `default_config.py` named `config.py`, and make any changes you see fit. Each field should be described in the file.
When finished, run the server with:
python3 main.py
## Developing on this
If you plan on making changes to the code, i advice you to install [`entr`](http://entrproject.org/) and use the supplied script `dev.sh`.
It will restart the server everytime you write a change to any of the .py files in the project.
2018-02-26 23:06:09 +01:00
## License
Licensed under BSD 3 clause, see the file LICENSE for more details
This uses the library REMI by dddomodossola, which is licensed under apache2.
This license may be read [over here](https://choosealicense.com/licenses/apache-2.0/)