Skip to content

Commit

Permalink
docs(*): Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
julienloizelet committed Feb 1, 2024
1 parent f33c50f commit ce344b5
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 4 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# Example Usage
![CrowdSec Logo](https://raw.githubusercontent.com/crowdsecurity/python-capi-sdk/main/docs/images/logo_crowdsec.png)

See the [examples](examples) directory for some basic usage examples.
# CrowdSec CAPI Python SDK

> A Python SDK to do the heavy lifting of interacting with CAPI.

## Usage

See the [examples](examples) directory for some basic usage examples.

## Installation

See [Installation Guide](https://github.com/crowdsecurity/python-capi-sdk/blob/main/docs/INSTALLATION_GUIDE.md)

## Developer guide

See [Developer guide](https://github.com/crowdsecurity/python-capi-sdk/blob/main/docs/DEVELOPER.md)


## License

[MIT](https://github.com/crowdsecurity/python-capi-sdk/blob/main/LICENSE)
30 changes: 30 additions & 0 deletions docs/DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
![CrowdSec Logo](images/logo_crowdsec.png)
# CrowdSec CAPI Python SDK

## Developer guide


## Local installation

### Virtual environment

```bash
python -m venv venv
source venv/bin/activate
```

### Install dependencies

```bash
pip install --upgrade pip
python install -r requirements.txt
pip install -r requirements-dev.txt
```

## Unit tests

```bash
python -m pytest
```


9 changes: 9 additions & 0 deletions docs/INSTALLATION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
![CrowdSec Logo](images/logo_crowdsec.png)

# CrowdSec CAPI Python SDK

## Installation Guide

## Requirements

- Python >= 3.9
Binary file added docs/images/logo_crowdsec.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ author_email = [email protected]
description = CAPI Client For CrowdSec
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/crowdsecurity/cscapi
url = https://github.com/crowdsecurity/python-capi-sdk
project_urls =
Bug Tracker = https://github.com/crowdsecurity/pycrowdsec/issues
Bug Tracker = https://github.com/crowdsecurity/python-capi-sdk/issues
classifiers =
Programming Language :: Python :: 3
Operating System :: OS Independent
Expand Down

0 comments on commit ce344b5

Please sign in to comment.