Skip to content
README.md 1.17 KiB
Newer Older
nimrod's avatar
nimrod committed
# Poquita

nimrod's avatar
nimrod committed
[![pipeline status](https://git.shore.co.il/nimrod/poquita/badges/master/pipeline.svg)](https://git.shore.co.il/nimrod/poquita/-/commits/master)

> My setup of [Poca](https://github.com/brokkr/poca/).
nimrod's avatar
nimrod committed

My setup consists of keeping the subscriptions in git (`poca.xml`), managing
them locally and running the downloader inside a Docker container remotely. The
final part of syncing the downloads is using unison and is managed in my
[rcfiles](https://www.shore.co.il/git/rcfiles) repository.
nimrod's avatar
nimrod committed

## Requirements
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
- Python 3.10
nimrod's avatar
nimrod committed
- [Pipenv](https://pipenv.pypa.io/)
nimrod's avatar
nimrod committed

## Usage
nimrod's avatar
nimrod committed

Adding/ removing/ list/ toggling subscriptions:
nimrod's avatar
nimrod committed

```
pipenv run subscribe {add,delete,list,toggle}
```
nimrod's avatar
nimrod committed

Deploying a new version:
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
pipenv run build
pipenv run deploy
```
nimrod's avatar
nimrod committed

Linting (using [pre-commit](https://pre-commit.com/)):
nimrod's avatar
nimrod committed

```
pipenv run lint
```
nimrod's avatar
nimrod committed

## License
nimrod's avatar
nimrod committed

This software is licensed under the MIT license (see `LICENSE.txt`).
nimrod's avatar
nimrod committed

## Author Information

Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my
[website](https://www.shore.co.il/). Patches are welcome via
[`git send-email`](http://git-scm.com/book/en/v2/Git-Commands-Email). The repository
nimrod's avatar
nimrod committed
is located at: <https://git.shore.co.il/explore/>.