https://github.com/hbjydev/pastr
An open-source pastebin/file hosting/link shortening tool, built as services using Python with FastAPI
https://github.com/hbjydev/pastr
Last synced: about 2 months ago
JSON representation
An open-source pastebin/file hosting/link shortening tool, built as services using Python with FastAPI
- Host: GitHub
- URL: https://github.com/hbjydev/pastr
- Owner: hbjydev
- License: bsd-3-clause
- Created: 2021-05-30T16:26:25.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-05T18:01:58.000Z (almost 4 years ago)
- Last Synced: 2025-01-26T16:44:29.204Z (4 months ago)
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pastr
An open-source pastebin/file hosting/link shortening tool, built as services
using Python with Flask. It is designed in a microservices architecture, with
suggested deployment being onto a Kubernetes cluster.
It uses [Redis](https://redis.io), [Minio](https://min.io), and
[PostgreSQL](https://postgresql.org) to provide the features it does.
## Features
- [ ] A simple link shortening service
- [ ] A simple pastebin service
- [ ] A simple file uploading service
## Development
To start working on Pastr, you need a development environment. I personally use
a virtualenv at the top-level which all services' dependencies are installed
into. However, there are also multiple container specs in the repository for
the individual services and their dependencies.
```shell
$ gh repo clone hbjydev/pastr
$ cd pastr
$ python3 -m virtualenv venv
$ source venv/bin/activate
(venv) $ pip install -r {drop,paste,shorten}/requirements.txt
(venv) $ pip install -r {drop,paste,shorten}/requirements-dev.txt
```
From there, you can use `uvicorn` to run each individual service independently,
or you can spin up the entire stack using `docker-compose` and the provided
`docker-compose.yml` configuration.
### Tests
To run tests, each service has a set of pytest-compatible test specs in their
`tests/` directories.
## License
This software is licensed in its entirety under the
[BSD 3-Clause License](./LICENSE), which is kept at the top level, and at the
service-level as well.