-
Notifications
You must be signed in to change notification settings - Fork 92
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
Showing
18 changed files
with
310 additions
and
157 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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
env: | ||
virtualenv env | ||
|
||
build: | ||
rm -rf dist && python -m build | ||
|
||
release: | ||
twine upload dist/* |
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,63 @@ | ||
<p align="center"> | ||
<img alt="logo" src="https://storage.googleapis.com/metlo-security-public-images/metlo_logo_horiz%404x.png" height="80"> | ||
<h1 align="center">Metlo API Security</h1> | ||
<p align="center">Secure Your API.</p> | ||
</p> | ||
|
||
## Installation | ||
|
||
Currently Metlo's Python Agent supports 2 servers: | ||
|
||
- Django | ||
- Flask | ||
|
||
It can be installed from `pypi` by running : | ||
|
||
```shell | ||
pip install metlo | ||
``` | ||
|
||
## Configuration | ||
|
||
### Django | ||
|
||
Once installed, Metlo's middleware can be added by modifying middlewares list (in the projects `settings.py`) like so: | ||
|
||
```python | ||
MIDDLEWARE = [ | ||
..., | ||
"metlo.django.MetloDjango", | ||
] | ||
``` | ||
|
||
and configuring a `METLO_CONFIG` attribute in the projects `settings.py` like this : | ||
|
||
```python | ||
METLO_CONFIG = { | ||
"API_KEY": "<YOUR_METLO_API_KEY>", | ||
"METLO_HOST": "<YOUR_METLO_COLLECTOR_URL>" | ||
} | ||
``` | ||
|
||
`METLO_CONFIG` can take an optional key-value pair representing the max number of workers for communicating with METLO. | ||
|
||
### Flask | ||
|
||
Once installed, METLO middleware can be added simply like : | ||
|
||
```python | ||
from flask import Flask | ||
|
||
... | ||
from metlo.flask import MetloFlask | ||
|
||
app = Flask(__name__) | ||
MetloFlask(app, "<YOUR_METLO_COLLECTOR_URL>", "<YOUR_METLO_API_KEY>") | ||
``` | ||
|
||
The Flask Middleware takes the flask app, METLO collector url, and the METLO API Key as parameters. As an optional | ||
parameter, a named value can be passed for max number of workers for communicating with METLO. | ||
|
||
```python | ||
MetloFlask(app, "<YOUR_METLO_COLLECTOR_URL>", "<YOUR_METLO_API_KEY>", workers="<WORKER-COUNT>") | ||
``` |
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,88 @@ | ||
Metadata-Version: 2.1 | ||
Name: metlo | ||
Version: 0.0.14 | ||
Summary: The Python Agent for Metlo | ||
Home-page: https://www.metlo.com | ||
License: MIT | ||
Project-URL: Documentation, https://docs.metlo.com/docs/python | ||
Project-URL: Source Code, https://github.com/metlo-labs/metlo/ | ||
Project-URL: Issue Tracker, https://github.com/metlo-labs/metlo/issues/ | ||
Project-URL: Twitter, https://mobile.twitter.com/metlohq | ||
Project-URL: Chat, https://discord.gg/gasqPDKEAC | ||
Classifier: Development Status :: 3 - Alpha | ||
Classifier: Intended Audience :: Developers | ||
Classifier: Operating System :: OS Independent | ||
Classifier: License :: OSI Approved :: MIT License | ||
Classifier: Programming Language :: Python :: 3 | ||
Classifier: Programming Language :: Python :: 3.4 | ||
Classifier: Programming Language :: Python :: 3.5 | ||
Classifier: Programming Language :: Python :: 3.6 | ||
Classifier: Programming Language :: Python :: 3.7 | ||
Classifier: Programming Language :: Python :: 3.8 | ||
Classifier: Programming Language :: Python :: 3.9 | ||
Requires-Python: >=3.4 | ||
Description-Content-Type: text/markdown | ||
|
||
<p align="center"> | ||
<img alt="logo" src="https://storage.googleapis.com/metlo-security-public-images/metlo_logo_horiz%404x.png" height="80"> | ||
<h1 align="center">Metlo API Security</h1> | ||
<p align="center">Secure Your API.</p> | ||
</p> | ||
|
||
## Installation | ||
|
||
Currently Metlo's Python Agent supports 2 servers: | ||
|
||
- Django | ||
- Flask | ||
|
||
It can be installed from `pypi` by running : | ||
|
||
```shell | ||
pip install metlo | ||
``` | ||
|
||
## Configuration | ||
|
||
### Django | ||
|
||
Once installed, Metlo's middleware can be added by modifying middlewares list (in the projects `settings.py`) like so: | ||
|
||
```python | ||
MIDDLEWARE = [ | ||
..., | ||
"metlo.django.MetloDjango", | ||
] | ||
``` | ||
|
||
and configuring a `METLO_CONFIG` attribute in the projects `settings.py` like this : | ||
|
||
```python | ||
METLO_CONFIG = { | ||
"API_KEY": "<YOUR_METLO_API_KEY>", | ||
"METLO_HOST": "<YOUR_METLO_COLLECTOR_URL>" | ||
} | ||
``` | ||
|
||
`METLO_CONFIG` can take an optional key-value pair representing the max number of workers for communicating with METLO. | ||
|
||
### Flask | ||
|
||
Once installed, METLO middleware can be added simply like : | ||
|
||
```python | ||
from flask import Flask | ||
|
||
... | ||
from metlo.flask import MetloFlask | ||
|
||
app = Flask(__name__) | ||
MetloFlask(app, "<YOUR_METLO_COLLECTOR_URL>", "<YOUR_METLO_API_KEY>") | ||
``` | ||
|
||
The Flask Middleware takes the flask app, METLO collector url, and the METLO API Key as parameters. As an optional | ||
parameter, a named value can be passed for max number of workers for communicating with METLO. | ||
|
||
```python | ||
MetloFlask(app, "<YOUR_METLO_COLLECTOR_URL>", "<YOUR_METLO_API_KEY>", workers="<WORKER-COUNT>") | ||
``` |
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,10 @@ | ||
README.md | ||
pyproject.toml | ||
setup.cfg | ||
metlo/__init__.py | ||
metlo/django.py | ||
metlo/flask.py | ||
metlo.egg-info/PKG-INFO | ||
metlo.egg-info/SOURCES.txt | ||
metlo.egg-info/dependency_links.txt | ||
metlo.egg-info/top_level.txt |
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 @@ | ||
|
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 @@ | ||
metlo |
This file was deleted.
Oops, something went wrong.
File renamed without changes.
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
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.