Skip to content

Commit

Permalink
highlight
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucas Swartsenburg committed Dec 13, 2023
1 parent 4e45205 commit 665554e
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The easiest way to try out a cipher is by using one of the 2 interfaces that are

![](docs/cli_recording.gif)

```bash
```shell
ciphy caesar encrypt --message "HELLO" --shift "3"
```

Expand All @@ -49,7 +49,7 @@ The OpenAPI definition will make it easy to publish this API on marketplaces lik

Either use one of the automatically generated documentation websites, or use cURL to try out the API:

```bash
```shell
curl --location 'https://cipher-algorithms-d6b034dd885b.herokuapp.com/api/v1/ciphers/caesar/decrypt' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
Expand All @@ -74,46 +74,46 @@ This repository has some basic CI set up:
### Installing the python module and ciphy CLI
1. (optional)
Create a virtual environment if you don't have one already
```bash
```shell
python3 -m venv .venv
```

Activate the virtual environment
```bash
```shell
source .venv/bin/activate
```
2. Install this package with pip
```bash
```shell
pip install .
```
### Installing dependencies for local development and the REST API
1. (optional)
Create a virtual environment if you don't have one already
```bash
```shell
python3 -m venv .venv
```

Activate the virtual environment
```bash
```shell
source .venv/bin/activate
```
2. Install dependencies
```bash
```shell
pip install -r requirements.txt
```

## Running the API locally
```bash
```shell
python -m flask --app "api/app.py" run
```

## Running the CLI locally
As a Python module:
```bash
```shell
python -m cipher_algorithms caesar encrypt --message "HELLO" --shift "3"
```
With the CLI:
```bash
```shell
ciphy caesar encrypt --message "HELLO" --shift "3"
```

Expand Down

0 comments on commit 665554e

Please sign in to comment.