Skip to content

Commit

Permalink
Syntax highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
juliannguyen4 committed Sep 28, 2022
1 parent d182e84 commit cd03812
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,27 @@
## Setup

Create a new virtual environment to test the code (recommended):
```
```bash session
python3 -m venv .venv
. .venv/bin/activate
```

To install dependencies for development:
```
```bash session
pip install -r requirements.txt
```

## Unit testing

The tests use a locally built and installed module for this code:
```
```bash session
# Build current code and install package
pip install --editable .
```

For now, unit tests rely on an Aerospike server to work.
Run a local Aerospike server on a Docker container:
```
```bash session
# Get the server image if not already downloaded
docker pull aerospike/aerospike-server

Expand All @@ -33,20 +33,20 @@ docker run --name aerospike -d -p 3000:3000 aerospike/aerospike-server

Wait a few seconds for Aerospike server to fully start.
Then run the tests:
```
```bash session
python3 tests/test.py
```

## Documentation

To build documentation:
```
```bash session
cd docs/
sphinx-build -b html . htmldir -W
```

Spelling errors must be corrected using:
```
```bash session
sphinx-build -b spelling . build -W
```

Expand All @@ -55,7 +55,7 @@ sphinx-build -b spelling . build -W
This code uses [flake8](https://github.com/pycqa/flake8) for codestyle checking.

To run codestyle tests:
```
```bash session
cd documentapi/
flake8 . --count --max-complexity=10 --show-source --max-line-length=127
```
Expand All @@ -68,7 +68,7 @@ This project depends on a [fork](https://github.com/aerospike-community/jsonpath

## Cleanup

```
```bash session
# Stop an delete the server
docker container stop aerospike
docker container rm aerospike
Expand Down

0 comments on commit cd03812

Please sign in to comment.