blog-to-cohost/README.md

45 lines
1.2 KiB
Markdown
Raw Normal View History

2022-10-23 19:45:41 +01:00
# blog-to-cohost
2022-10-23 20:00:45 +01:00
bot using [cohost.py](https://github.com/valknight/Cohost.py) and feedparser to automate posting blog posts to cohost
2022-10-23 19:54:15 +01:00
## System requirements
- Linux (Windows may work but is not tested)
- Python
- Pip
- Bash
- Docker (optional)
2022-10-23 19:54:15 +01:00
## Quicktstart
2022-10-23 19:54:15 +01:00
- clone the repo from <https://github.com/CrimsonTome/blog-to-cohost>
- `pip install -r requirements.txt` to install dependencies
- edit `scripts/main.py` with your changes
- `python3 scripts/main.py` to run
2022-10-23 20:00:45 +01:00
<!-- more steps soon -->
2022-10-23 19:54:15 +01:00
## Building
### Python
2022-10-23 20:00:45 +01:00
<!-- steps here -->
2022-10-23 19:54:15 +01:00
- `python3 scripts/main.py`
2022-10-23 19:54:15 +01:00
### Docker
2022-10-23 20:00:45 +01:00
<!-- steps here -->
- `docker build -t blog-to-cohost .`
2022-10-23 19:54:15 +01:00
## Contributing
2022-10-23 20:00:45 +01:00
<!-- TODO Add contributing guidelines -->
2022-10-23 19:54:15 +01:00
## License, Credits and Disclaimers
blog-to-cohost is licensed under the MIT License. The full license text is included in the [LICENSE](LICENSE) file in this repository. Tldr legal have a [great summary](https://www.tldrlegal.com/l/mit) of the license if you're interested.
2022-10-23 20:00:45 +01:00
This repo is built off [cohost.py](https://github.com/valknight/Cohost.py), a library for [cohost.org](https://cohost.org/)
2022-10-23 19:54:15 +01:00
No part of this code is approved by [cohost](https://cohost.org/), this uses an **unofficial** API.