-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f33c50f
commit ce344b5
Showing
5 changed files
with
63 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|