https://github.com/rafaeelaudibert/encryptor
Several encryptors (cryptographic secure or not) available in a REST API fashion, using Flask
https://github.com/rafaeelaudibert/encryptor
encryptors flask hacktoberfest sentry
Last synced: 12 months ago
JSON representation
Several encryptors (cryptographic secure or not) available in a REST API fashion, using Flask
- Host: GitHub
- URL: https://github.com/rafaeelaudibert/encryptor
- Owner: rafaeelaudibert
- Created: 2019-09-26T01:07:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T22:55:44.000Z (over 3 years ago)
- Last Synced: 2023-03-03T09:49:42.695Z (over 3 years ago)
- Topics: encryptors, flask, hacktoberfest, sentry
- Language: Python
- Homepage:
- Size: 586 KB
- Stars: 6
- Watchers: 2
- Forks: 16
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# :lock: :key: Encryptor
Several encryptors (cryptographic secure or not) available in a REST API
fashion, using Flask
## :computer: Running
- To configure Sentry, you need to create an account at sentry.io and generate a
key. You can set it as an environment variable with the name `SENTRY_DSN` or
create a `.env` and create an entry `SENTRY_DSN=`
- To install the required libraries you should run
`pip install -r requirements.txt && pip install -e .`
- To run the application, you just need to run the following command, and access
the API at port 5000 of your local host: `FLASK_APP=encryptor flask run`
## :vertical_traffic_light: Trying out
You can try out each encryptor in their respective route based in the following
model:
`localhost:5000/api/:encryptor/{encrypt|decrypt}/:text?option_1=x&option_2=y`,
where you can see the required options in each route at the source file. Example
to encrypt the text github with an offset of 4, using a `Ceasar` cypher:
`localhost:5000/api/ceasar/encrypt/github?offset=4`.
## :white_check_mark: Tests
You can test this application running the `pytest` command
## :muscle: Contributing
You may check [CONTRIBUTING.md](./CONTRIBUTING.md) if you want to contribute to
the project! I would highly reccommend you to do so, as we are trying to build
something really nice and beginner friendly.
## :busts_in_silhouette: Contributors
- [RafaAudibert](https://github.com/rafaeelaudibert) - Author
- [Artyko](https://github.com/Artyko) - Code Contributor
- [Pragyan Mehrotra](https://github.com/pragyanmehrotra) - Code Contributor
- [NinoCosmic](https://github.com/NinoCosmic) - Code Contributor
- [Andrea Churchville](https://github.com/AndChurchville) - LogoMaker