https://github.com/janbrohl/netkan-api
Proof-of-concept for a NetKAN-API
https://github.com/janbrohl/netkan-api
Last synced: about 2 months ago
JSON representation
Proof-of-concept for a NetKAN-API
- Host: GitHub
- URL: https://github.com/janbrohl/netkan-api
- Owner: janbrohl
- License: mit
- Created: 2016-07-05T11:24:18.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T15:45:41.000Z (11 months ago)
- Last Synced: 2025-02-07T17:45:55.544Z (3 months ago)
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# NetKAN-API
[🍕Buy me a Pizza](https://www.buymeacoffee.com/janbrohl>)
This is a proof of concept for a web-based API to make pull-requests to NetKAN ( https://github.com/KSP-CKAN/NetKAN ) so changes would only have to be approved by the KSP-CKAN team.
I tested it on a different repo and it seems to work so far but it is totally __NOT__ production-ready
Propably I will not put much (if any) work in this myself but I will happily merge pull requests.
## How can I try it?
### You need
- A fork of https://github.com/KSP-CKAN/NetKAN
- git
- Python 3.4+ (propably any 3.* will do but installation gets more complex)
### Run the server
- Create a new folder and put this repository's contents in it.
- Have a look at example-config.json and create your own config.json to suit your needs
- Create a [Virtual Environment](https://docs.python.org/3/library/venv.html) inside that folder and activate it.
- `python -m ensurepip --upgrade`
- `pip install -r requirements.txt`
- `python netkan_api.py`
### Upload a file
POST JSON data to http://127.0.0.1:8080/netkan/ModName-ModVersion
data must be of the form `{"entry":ContentsOfYourNetkanFile, "messsage":"Message To Add To The Pull Request"}`