apitally 0.1.0__tar.gz → 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,163 @@
1
+ Metadata-Version: 2.1
2
+ Name: apitally
3
+ Version: 0.1.1
4
+ Summary: Apitally client library for Python
5
+ Home-page: https://docs.apitally.io
6
+ License: MIT
7
+ Author: Apitally
8
+ Author-email: hello@apitally.io
9
+ Requires-Python: >=3.8,<4.0
10
+ Classifier: Framework :: Django
11
+ Classifier: Framework :: FastAPI
12
+ Classifier: Framework :: Flask
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.8
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Provides-Extra: django-ninja
21
+ Provides-Extra: django-rest-framework
22
+ Provides-Extra: fastapi
23
+ Provides-Extra: flask
24
+ Provides-Extra: starlette
25
+ Requires-Dist: backoff (>=2.0.0)
26
+ Requires-Dist: django (>=4.0) ; extra == "django-rest-framework" or extra == "django-ninja"
27
+ Requires-Dist: django-ninja (>=0.18.0) ; extra == "django-ninja"
28
+ Requires-Dist: djangorestframework (>=3.12.0) ; extra == "django-rest-framework"
29
+ Requires-Dist: fastapi (>=0.87.0) ; extra == "fastapi"
30
+ Requires-Dist: flask (>=2.0.0) ; extra == "flask"
31
+ Requires-Dist: httpx (>=0.22.0) ; extra == "fastapi" or extra == "starlette"
32
+ Requires-Dist: requests (>=2.26.0) ; extra == "django-rest-framework" or extra == "django-ninja" or extra == "flask"
33
+ Requires-Dist: starlette (>=0.21.0) ; extra == "fastapi" or extra == "starlette"
34
+ Project-URL: Documentation, https://docs.apitally.io
35
+ Project-URL: Repository, https://github.com/apitally/python-client
36
+ Description-Content-Type: text/markdown
37
+
38
+ <p align="center">
39
+ <picture>
40
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/apitally/assets/main/logo-vertical-dark.png">
41
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/apitally/assets/main/logo-vertical-light.png">
42
+ <img alt="Apitally logo" src="https://raw.githubusercontent.com/apitally/assets/main/logo-vertical-light.png">
43
+ </picture>
44
+ </p>
45
+
46
+ <p align="center"><b>Your refreshingly simple REST API companion.</b></p>
47
+
48
+ <p align="center"><i>Apitally offers API traffic monitoring and integrated API key management that is extremely easy to set up and use with new and existing API projects. No assumptions made about your infrastructure, no extra tools for you to host and maintain.</i></p>
49
+
50
+ <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
51
+
52
+ ![Apitally screenshots](https://raw.githubusercontent.com/apitally/assets/main/overview.png)
53
+
54
+ ---
55
+
56
+ # Apitally client for Python
57
+
58
+ [![Tests](https://github.com/apitally/python-client/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/python-client/actions)
59
+ [![Codecov](https://codecov.io/gh/apitally/python-client/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/python-client)
60
+ [![PyPI](https://img.shields.io/pypi/v/apitally?logo=pypi&logoColor=white&color=%23006dad)](https://pypi.org/project/apitally/)
61
+
62
+ This client library currently supports the following frameworks:
63
+
64
+ - [FastAPI](https://docs.apitally.io/frameworks/fastapi)
65
+ - [Starlette](https://docs.apitally.io/frameworks/starlette)
66
+ - [Flask](https://docs.apitally.io/frameworks/flask)
67
+ - [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
68
+ - [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
69
+
70
+ ## Install
71
+
72
+ Use `pip` to install and provide your framework of choice as an extra, for example:
73
+
74
+ ```bash
75
+ pip install apitally[fastapi]
76
+ ```
77
+
78
+ The available extras are: `fastapi`, `starlette`, `flask`, `django_ninja` and `django_rest_framework`.
79
+
80
+ ## Usage
81
+
82
+ Below are basic usage examples for each supported framework. For further instructions and examples, including how to identify consumers and use API key authentication, check out our [documentation](https://docs.apitally.io/).
83
+
84
+ ### FastAPI
85
+
86
+ ```python
87
+ from fastapi import FastAPI
88
+ from apitally.fastapi import ApitallyMiddleware
89
+
90
+ app = FastAPI()
91
+ app.add_middleware(
92
+ ApitallyMiddleware,
93
+ client_id="your-client-id",
94
+ env="your-env-name",
95
+ )
96
+ ```
97
+
98
+ ### Starlette
99
+
100
+ ```python
101
+ from starlette.applications import Starlette
102
+ from apitally.starlette import ApitallyMiddleware
103
+
104
+ app = Starlette(routes=[...])
105
+ app.add_middleware(
106
+ ApitallyMiddleware,
107
+ client_id="your-client-id",
108
+ env="your-env-name",
109
+ )
110
+ ```
111
+
112
+ ### Flask
113
+
114
+ ```python
115
+ from flask import Flask
116
+ from apitally.flask import ApitallyMiddleware
117
+
118
+ app = Flask(__name__)
119
+ app.wsgi_app = ApitallyMiddleware(
120
+ app,
121
+ client_id="your-client-id",
122
+ env="your-env-name",
123
+ )
124
+ ```
125
+
126
+ ### Django Ninja
127
+
128
+ In your Django `settings.py` file:
129
+
130
+ ```python
131
+ MIDDLEWARE = [
132
+ # Other middlewares first ...
133
+ "apitally.django_ninja.ApitallyMiddleware",
134
+ ]
135
+ APITALLY_MIDDLEWARE = {
136
+ "client_id": "your-client-id",
137
+ "env": "your-env-name",
138
+ }
139
+ ```
140
+
141
+ ### Django REST Framework
142
+
143
+ In your Django `settings.py` file:
144
+
145
+ ```python
146
+ MIDDLEWARE = [
147
+ # Other middlewares first ...
148
+ "apitally.django_rest_framework.ApitallyMiddleware",
149
+ ]
150
+ APITALLY_MIDDLEWARE = {
151
+ "client_id": "your-client-id",
152
+ "env": "your-env-name",
153
+ }
154
+ ```
155
+
156
+ ## Getting help
157
+
158
+ If you need help please join our [Apitally community on Slack](https://apitally-community.slack.com/) or [create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a) on GitHub.
159
+
160
+ ## License
161
+
162
+ This library is licensed under the terms of the MIT license.
163
+
@@ -0,0 +1,125 @@
1
+ <p align="center">
2
+ <picture>
3
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/apitally/assets/main/logo-vertical-dark.png">
4
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/apitally/assets/main/logo-vertical-light.png">
5
+ <img alt="Apitally logo" src="https://raw.githubusercontent.com/apitally/assets/main/logo-vertical-light.png">
6
+ </picture>
7
+ </p>
8
+
9
+ <p align="center"><b>Your refreshingly simple REST API companion.</b></p>
10
+
11
+ <p align="center"><i>Apitally offers API traffic monitoring and integrated API key management that is extremely easy to set up and use with new and existing API projects. No assumptions made about your infrastructure, no extra tools for you to host and maintain.</i></p>
12
+
13
+ <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
14
+
15
+ ![Apitally screenshots](https://raw.githubusercontent.com/apitally/assets/main/overview.png)
16
+
17
+ ---
18
+
19
+ # Apitally client for Python
20
+
21
+ [![Tests](https://github.com/apitally/python-client/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/python-client/actions)
22
+ [![Codecov](https://codecov.io/gh/apitally/python-client/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/python-client)
23
+ [![PyPI](https://img.shields.io/pypi/v/apitally?logo=pypi&logoColor=white&color=%23006dad)](https://pypi.org/project/apitally/)
24
+
25
+ This client library currently supports the following frameworks:
26
+
27
+ - [FastAPI](https://docs.apitally.io/frameworks/fastapi)
28
+ - [Starlette](https://docs.apitally.io/frameworks/starlette)
29
+ - [Flask](https://docs.apitally.io/frameworks/flask)
30
+ - [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
31
+ - [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
32
+
33
+ ## Install
34
+
35
+ Use `pip` to install and provide your framework of choice as an extra, for example:
36
+
37
+ ```bash
38
+ pip install apitally[fastapi]
39
+ ```
40
+
41
+ The available extras are: `fastapi`, `starlette`, `flask`, `django_ninja` and `django_rest_framework`.
42
+
43
+ ## Usage
44
+
45
+ Below are basic usage examples for each supported framework. For further instructions and examples, including how to identify consumers and use API key authentication, check out our [documentation](https://docs.apitally.io/).
46
+
47
+ ### FastAPI
48
+
49
+ ```python
50
+ from fastapi import FastAPI
51
+ from apitally.fastapi import ApitallyMiddleware
52
+
53
+ app = FastAPI()
54
+ app.add_middleware(
55
+ ApitallyMiddleware,
56
+ client_id="your-client-id",
57
+ env="your-env-name",
58
+ )
59
+ ```
60
+
61
+ ### Starlette
62
+
63
+ ```python
64
+ from starlette.applications import Starlette
65
+ from apitally.starlette import ApitallyMiddleware
66
+
67
+ app = Starlette(routes=[...])
68
+ app.add_middleware(
69
+ ApitallyMiddleware,
70
+ client_id="your-client-id",
71
+ env="your-env-name",
72
+ )
73
+ ```
74
+
75
+ ### Flask
76
+
77
+ ```python
78
+ from flask import Flask
79
+ from apitally.flask import ApitallyMiddleware
80
+
81
+ app = Flask(__name__)
82
+ app.wsgi_app = ApitallyMiddleware(
83
+ app,
84
+ client_id="your-client-id",
85
+ env="your-env-name",
86
+ )
87
+ ```
88
+
89
+ ### Django Ninja
90
+
91
+ In your Django `settings.py` file:
92
+
93
+ ```python
94
+ MIDDLEWARE = [
95
+ # Other middlewares first ...
96
+ "apitally.django_ninja.ApitallyMiddleware",
97
+ ]
98
+ APITALLY_MIDDLEWARE = {
99
+ "client_id": "your-client-id",
100
+ "env": "your-env-name",
101
+ }
102
+ ```
103
+
104
+ ### Django REST Framework
105
+
106
+ In your Django `settings.py` file:
107
+
108
+ ```python
109
+ MIDDLEWARE = [
110
+ # Other middlewares first ...
111
+ "apitally.django_rest_framework.ApitallyMiddleware",
112
+ ]
113
+ APITALLY_MIDDLEWARE = {
114
+ "client_id": "your-client-id",
115
+ "env": "your-env-name",
116
+ }
117
+ ```
118
+
119
+ ## Getting help
120
+
121
+ If you need help please join our [Apitally community on Slack](https://apitally-community.slack.com/) or [create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a) on GitHub.
122
+
123
+ ## License
124
+
125
+ This library is licensed under the terms of the MIT license.
@@ -0,0 +1 @@
1
+ __version__ = "0.1.1"
@@ -4,12 +4,20 @@ build-backend = "poetry_dynamic_versioning.backend"
4
4
 
5
5
  [tool.poetry]
6
6
  name = "apitally"
7
- version = "0.1.0"
7
+ version = "0.1.1"
8
8
  description = "Apitally client library for Python"
9
- authors = ["Simon Gurcke <simon@gurcke.de>"]
10
- license = "MIT License"
11
- repository = "https://github.com/apitally/apitally-python"
12
9
  readme = "README.md"
10
+ authors = ["Apitally <hello@apitally.io>"]
11
+ license = "MIT License"
12
+ homepage = "https://docs.apitally.io"
13
+ documentation = "https://docs.apitally.io"
14
+ repository = "https://github.com/apitally/python-client"
15
+ classifiers = [
16
+ "Framework :: FastAPI",
17
+ "Framework :: Django",
18
+ "Framework :: Flask",
19
+ "Intended Audience :: Developers",
20
+ ]
13
21
 
14
22
  [tool.poetry.dependencies]
15
23
  backoff = ">=2.0.0"
apitally-0.1.0/PKG-INFO DELETED
@@ -1,118 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: apitally
3
- Version: 0.1.0
4
- Summary: Apitally client library for Python
5
- Home-page: https://github.com/apitally/apitally-python
6
- License: MIT
7
- Author: Simon Gurcke
8
- Author-email: simon@gurcke.de
9
- Requires-Python: >=3.8,<4.0
10
- Classifier: License :: OSI Approved :: MIT License
11
- Classifier: Programming Language :: Python :: 3
12
- Classifier: Programming Language :: Python :: 3.8
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Provides-Extra: django-ninja
17
- Provides-Extra: django-rest-framework
18
- Provides-Extra: fastapi
19
- Provides-Extra: flask
20
- Provides-Extra: starlette
21
- Requires-Dist: backoff (>=2.0.0)
22
- Requires-Dist: django (>=4.0) ; extra == "django-rest-framework" or extra == "django-ninja"
23
- Requires-Dist: django-ninja (>=0.18.0) ; extra == "django-ninja"
24
- Requires-Dist: djangorestframework (>=3.12.0) ; extra == "django-rest-framework"
25
- Requires-Dist: fastapi (>=0.87.0) ; extra == "fastapi"
26
- Requires-Dist: flask (>=2.0.0) ; extra == "flask"
27
- Requires-Dist: httpx (>=0.22.0) ; extra == "fastapi" or extra == "starlette"
28
- Requires-Dist: requests (>=2.26.0) ; extra == "django-rest-framework" or extra == "django-ninja" or extra == "flask"
29
- Requires-Dist: starlette (>=0.21.0) ; extra == "fastapi" or extra == "starlette"
30
- Project-URL: Repository, https://github.com/apitally/apitally-python
31
- Description-Content-Type: text/markdown
32
-
33
- # Apitally client for Python
34
-
35
- [![Tests](https://github.com/apitally/python-client/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/python-client/actions)
36
- [![Codecov](https://codecov.io/gh/apitally/python-client/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/python-client)
37
- [![PyPI](https://img.shields.io/pypi/v/apitally?logo=pypi&logoColor=white&color=%23006dad)](https://pypi.org/project/apitally/)
38
-
39
- Apitally client library for Python.
40
-
41
- Currently supports the following frameworks:
42
-
43
- - [FastAPI](https://fastapi.tiangolo.com/)
44
- - [Starlette](https://www.starlette.io/)
45
- - [Django Ninja](https://django-ninja.rest-framework.com/)
46
- - [Django REST Framework](https://www.django-rest-framework.org/)
47
- - [Flask](https://flask.palletsprojects.com/)
48
-
49
- ## Installation
50
-
51
- Use `pip` to install and provide your framework of choice as an extra, for example:
52
-
53
- ```bash
54
- pip install apitally[fastapi]
55
- ```
56
-
57
- The available extras are: `fastapi`, `starlette`, `django_ninja`, `django_rest_framework` and `flask`.
58
-
59
- ## Basic usage
60
-
61
- Below are basic usage examples for each supported framework. For more detailed instructions and examples, including on how to use Apitally API key authentication, see the [documentation](https://docs.apitally.com/).
62
-
63
- ### With FastAPI
64
-
65
- ```python
66
- from fastapi import FastAPI
67
- from apitally.fastapi import ApitallyMiddleware
68
-
69
- app = FastAPI()
70
- app.add_middleware(ApitallyMiddleware, client_id="<your-client-id>")
71
- ```
72
-
73
- ### With Starlette
74
-
75
- ```python
76
- from starlette.applications import Starlette
77
- from apitally.starlette import ApitallyMiddleware
78
-
79
- app = Starlette()
80
- app.add_middleware(ApitallyMiddleware, client_id="<your-client-id>")
81
- ```
82
-
83
- ### With Django Ninja
84
-
85
- In your Django `settings.py` file:
86
-
87
- ```python
88
- MIDDLEWARE = [
89
- "apitally.django_ninja.ApitallyMiddleware",
90
- ]
91
- APITALLY_MIDDLEWARE = {
92
- "client_id": "<your-client-id>",
93
- }
94
- ```
95
-
96
- ### With Django REST Framework
97
-
98
- In your Django `settings.py` file:
99
-
100
- ```python
101
- MIDDLEWARE = [
102
- "apitally.django_rest_framework.ApitallyMiddleware",
103
- ]
104
- APITALLY_MIDDLEWARE = {
105
- "client_id": "<your-client-id>",
106
- }
107
- ```
108
-
109
- ### With Flask
110
-
111
- ```python
112
- from flask import Flask
113
- from apitally.flask import ApitallyMiddleware
114
-
115
- app = Flask(__name__)
116
- app.wsgi_app = ApitallyMiddleware(app, client_id="<your-client-id>")
117
- ```
118
-
apitally-0.1.0/README.md DELETED
@@ -1,85 +0,0 @@
1
- # Apitally client for Python
2
-
3
- [![Tests](https://github.com/apitally/python-client/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/python-client/actions)
4
- [![Codecov](https://codecov.io/gh/apitally/python-client/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/python-client)
5
- [![PyPI](https://img.shields.io/pypi/v/apitally?logo=pypi&logoColor=white&color=%23006dad)](https://pypi.org/project/apitally/)
6
-
7
- Apitally client library for Python.
8
-
9
- Currently supports the following frameworks:
10
-
11
- - [FastAPI](https://fastapi.tiangolo.com/)
12
- - [Starlette](https://www.starlette.io/)
13
- - [Django Ninja](https://django-ninja.rest-framework.com/)
14
- - [Django REST Framework](https://www.django-rest-framework.org/)
15
- - [Flask](https://flask.palletsprojects.com/)
16
-
17
- ## Installation
18
-
19
- Use `pip` to install and provide your framework of choice as an extra, for example:
20
-
21
- ```bash
22
- pip install apitally[fastapi]
23
- ```
24
-
25
- The available extras are: `fastapi`, `starlette`, `django_ninja`, `django_rest_framework` and `flask`.
26
-
27
- ## Basic usage
28
-
29
- Below are basic usage examples for each supported framework. For more detailed instructions and examples, including on how to use Apitally API key authentication, see the [documentation](https://docs.apitally.com/).
30
-
31
- ### With FastAPI
32
-
33
- ```python
34
- from fastapi import FastAPI
35
- from apitally.fastapi import ApitallyMiddleware
36
-
37
- app = FastAPI()
38
- app.add_middleware(ApitallyMiddleware, client_id="<your-client-id>")
39
- ```
40
-
41
- ### With Starlette
42
-
43
- ```python
44
- from starlette.applications import Starlette
45
- from apitally.starlette import ApitallyMiddleware
46
-
47
- app = Starlette()
48
- app.add_middleware(ApitallyMiddleware, client_id="<your-client-id>")
49
- ```
50
-
51
- ### With Django Ninja
52
-
53
- In your Django `settings.py` file:
54
-
55
- ```python
56
- MIDDLEWARE = [
57
- "apitally.django_ninja.ApitallyMiddleware",
58
- ]
59
- APITALLY_MIDDLEWARE = {
60
- "client_id": "<your-client-id>",
61
- }
62
- ```
63
-
64
- ### With Django REST Framework
65
-
66
- In your Django `settings.py` file:
67
-
68
- ```python
69
- MIDDLEWARE = [
70
- "apitally.django_rest_framework.ApitallyMiddleware",
71
- ]
72
- APITALLY_MIDDLEWARE = {
73
- "client_id": "<your-client-id>",
74
- }
75
- ```
76
-
77
- ### With Flask
78
-
79
- ```python
80
- from flask import Flask
81
- from apitally.flask import ApitallyMiddleware
82
-
83
- app = Flask(__name__)
84
- app.wsgi_app = ApitallyMiddleware(app, client_id="<your-client-id>")
85
- ```
@@ -1 +0,0 @@
1
- __version__ = "0.1.0"
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes