Skip to content

Commit 9fa4c1e

Browse files
Extend project metadata for better display in PyPI
1 parent 6590966 commit 9fa4c1e

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

setup.py

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
"""
2+
Mensor is a graph-based computation engine for computing measures and metrics.
3+
It:
4+
5+
- defines a new grammar for extracting measures and metrics that is designed to
6+
be intuitive and capable (it can do almost(?) anything that makes sense to
7+
do with metrics and measures).
8+
- makes measure and metric definitions explicit and shareable, and their
9+
computations transparent and reproducible.
10+
- allows multiple data sources to be stitched together on the fly without users
11+
having to explicitly write the code / query required to join the data sources.
12+
- is agnostic as to how data is stored or accessed, and new data backends are
13+
relatively simple to write.
14+
- allows for local ad-hoc definitions of additional data sources for exploration
15+
by data scientists or other technically minded folk, decoupling it from
16+
deployment into production services.
17+
18+
**Note:** Mensor is currently still under heavy development, and intrusive
19+
changes to the API are expected. To minimise the impact on downstream projects,
20+
Mensor will strictly adhere to semantic versioning. In particular, any
21+
incompatible or sufficiently adventurous change to classes expected to be used
22+
outside of Mensor itself will resulting a major version bump. If you pin the
23+
version of Mensor used in your project using `mensor>=x.y(.z)?<x.y+1`
24+
(e.g. `mensor>=0.1.2<0.2`), you should be protected from any code churn and can
25+
upgrade to newer versions of Mensor after reading the release notes at your
26+
leisure.
27+
"""
28+
129
from setuptools import find_packages, setup
230

331
version_info = {}
@@ -7,10 +35,21 @@
735
setup(
836
name='mensor',
937
description="A dynamic graph-based metric computation engine.",
38+
long_description=__doc__.strip(),
39+
long_description_content_type='text/markdown',
1040
version=version_info['__version__'],
1141
author=version_info['__author__'],
1242
author_email=version_info['__author_email__'],
43+
license='MIT',
44+
url='http://github.com/airbnb/mensor',
45+
project_urls={
46+
'Documentation': 'http://mensor.readthedocs.io',
47+
'Source': 'https://github.com/airbnb/mensor',
48+
'Issue Tracker': 'https://github.com/airbnb/mensor/issues',
49+
},
50+
keywords='measures metrics aggregation experimentation statistics',
1351
packages=find_packages(),
52+
python_requires='~=3.4',
1453
install_requires=version_info['__dependencies__'],
1554
classifiers=[
1655
'Development Status :: 3 - Alpha',
@@ -19,6 +58,7 @@
1958
'Intended Audience :: Information Technology',
2059
'Intended Audience :: Science/Research',
2160
'License :: OSI Approved :: MIT License',
61+
'Programming Language :: Python :: 3',
2262
'Programming Language :: Python :: 3.4',
2363
'Programming Language :: Python :: 3.5',
2464
'Programming Language :: Python :: 3.6',

0 commit comments

Comments
 (0)