flagsmith-common 1.5.0__py3-none-any.whl

flagsmith_common-1.5.0.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.3
+Name: flagsmith-common
+Version: 1.5.0
+Summary: Flagsmith's common library
+License: BSD-3-Clause
+Author: Matthew Elwell
+Maintainer: Flagsmith Team
+Maintainer-email: support@flagsmith.com
+Requires-Python: >=3.11,<4.0
+Classifier: Framework :: Django
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: django (<5)
+Requires-Dist: django-health-check
+Requires-Dist: djangorestframework
+Requires-Dist: djangorestframework-recursive
+Requires-Dist: drf-writable-nested
+Requires-Dist: environs (<15)
+Requires-Dist: flagsmith-flag-engine
+Requires-Dist: gunicorn (>=19.1)
+Requires-Dist: prometheus-client (>=0.0.16)
+Project-URL: Download, https://github.com/flagsmith/flagsmith-common/releases
+Project-URL: Homepage, https://flagsmith.com
+Project-URL: Issues, https://github.com/flagsmith/flagsmith-common/issues
+Project-URL: Repository, https://github.com/flagsmith/flagsmith-common
+Description-Content-Type: text/markdown
+
+# flagsmith-common
+Flagsmith's common library
+
+### Development Setup
+
+This project uses [Poetry](https://python-poetry.org/) for dependency management and includes a Makefile to simplify common development tasks.
+
+#### Prerequisites
+
+- Python >= 3.11
+- Make
+
+#### Installation
+
+You can set up your development environment using the provided Makefile:
+
+```bash
+# Install everything (pip, poetry, and project dependencies)
+make install
+
+# Individual installation steps are also available
+make install-pip       # Upgrade pip
+make install-poetry    # Install Poetry
+make install-packages  # Install project dependencies
+```
+
+By default, Poetry version 2.0.1 will be installed. You can specify a different version:
+
+```bash
+make install-poetry POETRY_VERSION=2.1.0
+```
+
+#### Development
+
+Run linting checks using pre-commit:
+
+```bash
+make lint
+```
+
+Additional options can be passed to the `install-packages` target:
+
+```bash
+# Install with development dependencies
+make install-packages opts="--with dev"
+
+# Install with specific extras
+make install-packages opts="--extras 'feature1 feature2'"
+```
+
+### Usage
+
+#### Installation
+
+1. Make sure `"common.core"` is in the `INSTALLED_APPS` of your settings module.
+This enables the `manage.py flagsmith` commands.
+
+2. Add `"common.gunicorn.middleware.RouteLoggerMiddleware"` to `MIDDLEWARE` in your settings module.
+This enables the `route` label for Prometheus HTTP metrics.
+
+3. To enable the `/metrics` endpoint, set the `PROMETHEUS_ENABLED` setting to `True`.
+
+#### Metrics
+
+Flagsmith uses Prometheus to track performance metrics.
+
+The following default metrics are exposed:
+
+- `flagsmith_build_info`: Has the labels `version` and `ci_commit_sha`.
+- `http_server_request_duration_seconds`: Histogram labeled with `method`, `path`, and `response_status`.
+- `http_server_requests_total`: Counter labeled with `method`, `path`, and `response_status`.
+
+##### Guidelines
+
+Try to come up with meaningful metrics to cover your feature with when developing it. Refer to [Prometheus best practices][1] when naming your metric and labels.
+
+Define your metrics in a `metrics.py` module of your Django application — see [example][2]. Contrary to Prometheus Python client examples and documentation, please name a metric variable exactly as your metric name.
+
+It's generally a good idea to allow users to define histogram buckets of their own. Flagsmith accepts a `PROMETHEUS_HISTOGRAM_BUCKETS` setting so users can customise their buckets. To honour the setting, use the `common.prometheus.Histogram` class when defining your histograms. When using `prometheus_client.Histogram` directly, please expose a dedicated setting like so:
+
+```python
+import prometheus_client
+from django.conf import settings
+
+distance_from_earth_au = prometheus.Histogram(
+    "distance_from_earth_au",
+    "Distance from Earth in astronomical units",
+    buckets=settings.DISTANCE_FROM_EARTH_AU_HISTOGRAM_BUCKETS,
+)
+```
+
+[1]: https://prometheus.io/docs/practices/naming/
+[2]: https://github.com/Flagsmith/flagsmith-common/blob/main/src/common/gunicorn/metrics.py
+[3]: https://docs.gunicorn.org/en/stable/design.html#server-model
+[4]: https://prometheus.github.io/client_python/multiprocess
+

flagsmith_common-1.5.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/core/app.py,sha256=QRhmj2MPnbPwjjEje-QDlmgQuYWNq7cGoUiCf8Ky_GU,116
+common/core/logging.py,sha256=r2Ig21YIfq-R4MhtF614N2UjhW6EH1_Zs9BhrVLSQFk,807
+common/core/main.py,sha256=_-mzfs_lyct0kjQBD-hmalJ6h7IijFxyGTvGpcBSkeQ,1157
+common/core/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/core/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/core/management/commands/start.py,sha256=uexgTtsW9_Gu2atZA33XpSEQFRCj_Bk09THYG_6We4o,1199
+common/core/metrics.py,sha256=m-1XyO-HoOZXyc6wUmW6-dMLdiH4HcQhpNgFvTNtmh0,563
+common/core/urls.py,sha256=z9q_Ua-5F_2-UM2JdnMPuPf2NU_T91ujUxJJrThfWYI,774
+common/core/utils.py,sha256=f2FRNdB1r10p5gwgZ5CEkaXCCie_ocpczfYEtpFrj_M,2645
+common/core/views.py,sha256=QdXUaIgFQ28bLAVkEaQt3D6-X3iw-FeE4dWndH5dues,612
+common/environments/permissions.py,sha256=TkYOcRBYogasSJTMS1YxLffucO7ItsTklq3aRHalFhY,494
+common/features/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/features/multivariate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/features/multivariate/serializers.py,sha256=lryUuwSMC7-fo60KhyQRY-GPCaTF6Fzwy4qFZtdXozw,522
+common/features/serializers.py,sha256=qodyM6cGaCP8IHwyYuex_9CJMDBUDt9RUnHEo5zD7Q4,1995
+common/features/versioning/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/features/versioning/serializers.py,sha256=iyMrjy7_JsjD7E6KOSAd3P8QAhReEnAVgHkpt6BCAaA,439
+common/gunicorn/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/gunicorn/conf.py,sha256=rht6KqrnYpHRjP-3S8kwJEYIqjWkDX9Ggl-JAW_J4Kw,641
+common/gunicorn/constants.py,sha256=r83k97_qe8gcqK9QSrfEuKnhkwAMtMDIl8Sa0TQcDnE,52
+common/gunicorn/logging.py,sha256=QGoNRy8a81l-QGeFUNyv2xbePojelRNgK5Ko2qAZxjw,3165
+common/gunicorn/metrics.py,sha256=F8sUz-t9Ykfx6rFMy1ZmTPgrIVfxrmmPCUV0lD_SEYE,420
+common/gunicorn/middleware.py,sha256=iPM3LRw-kHVWgratNKy66B7PSoivjtecl-9bTPYp-b4,881
+common/gunicorn/utils.py,sha256=N0nu8UciKbldN1blzpDUWWZdwe2Mni40SoeyS4Z1a_0,2229
+common/metadata/serializers.py,sha256=9bMPakNZxaAKhx4uIDWDtITbt6PlPIgnjU1CHeDVPrk,3262
+common/organisations/permissions.py,sha256=zTtJHWGJU2JUV_GRb3RxsMYuWL01tyEiEbbAztmQ09s,318
+common/projects/permissions.py,sha256=uQXxfYhTtXk3JGukxUmXHULp2xPH4HaM1E0uQ4SxGcE,1677
+common/prometheus/__init__.py,sha256=iw9EDPtC-NnbuPequjwFLIwGKEq5vnWIsyX2hcX_7Bk,72
+common/prometheus/utils.py,sha256=_qsN5wfA7pA4RfpPDyqfwmvLAkCjarmL3QUjZOFuIek,555
+common/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+common/segments/serializers.py,sha256=Si9H2ccVgEa4KOjs8BqqGzEmCqemu43EnVKVV_Zcoco,12660
+common/test_tools/__init__.py,sha256=cTLbunC3SoXQmCuz5S25h2_9ls9Es6jczDr6VqPOhSE,92
+common/test_tools/plugin.py,sha256=7Sj3g63ESAVhlzfw-VKj40R-8e1zjckQhh4mpghZ82w,937
+common/test_tools/types.py,sha256=WXh3j_P0KmcQKJ9CxT_Bo4OPjuQ_reipa9lVHqgcRW8,208
+common/types.py,sha256=sgj8cUAG75EylkUNLvvg4aAn8tVpsSe_QU9idM24gL0,1341
+flagsmith_common-1.5.0.dist-info/LICENSE,sha256=54EKQkJZc4xBIMpkJNo9EdvDXGq5TefERvXaIFF8Dac,1496
+flagsmith_common-1.5.0.dist-info/METADATA,sha256=49cFv_IQpVYKqjYJ_RWuZevax1qVSLwU3v_K4MxiDqQ,4430
+flagsmith_common-1.5.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+flagsmith_common-1.5.0.dist-info/entry_points.txt,sha256=SsKB3kaA63LHPbpX4wXe7twAm956lPEt28m5GUquYeI,109
+flagsmith_common-1.5.0.dist-info/RECORD,,

flagsmith_common-1.5.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.0.1
+Root-Is-Purelib: true
+Tag: py3-none-any

flagsmith_common-1.5.0.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[console_scripts]
+flagsmith=common.core.main:main
+
+[pytest11]
+flagsmith-test-tools=common.test_tools.plugin
+