Skip to content

Commit ca417c4

Browse files
committed
fix pkg metadata for PyPI
1 parent 63a4f7a commit ca417c4

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Blackfire Continuous Profiler continuously collects and uploads profiling data t
1010

1111
## Installation
1212

13-
TODO: After deciding the pkg name
13+
```shell
14+
pip install blackfire_conprof
15+
```
1416

1517
## Example
1618

@@ -19,7 +21,7 @@ An example using the whole API interface:
1921
1. Install dependencies
2022

2123
```shell
22-
pip install XXX
24+
pip install blackfire_conprof
2325
```
2426

2527
2. Create `example.py` with the following code

setup.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
import io
12
from setuptools import setup
23

34
HOMEPAGE = "https://blackfire.io"
45
NAME = "blackfire_conprof"
56

7+
with io.open('README.md'), encoding='UTF-8') as f:
8+
long_description = f.read()
9+
610
exec(open('blackfire_conprof/version.py').read())
711
setup(
812
name=NAME,
@@ -13,8 +17,8 @@
1317
author_email="[email protected]",
1418
install_requires=["ddtrace==1.13.3"],
1519
description="Blackfire Continuous Profiler",
16-
long_description="Blackfire Continuous Profiler",
17-
long_description_content_type="text/x-rst",
20+
long_description=long_description,
21+
long_description_content_type="text/markdown",
1822
url=HOMEPAGE,
1923
classifiers=[
2024
"Programming Language :: Python",

0 commit comments

Comments
 (0)