Skip to content

Commit b5b1f98

Browse files
authored
Register project with pypi (#5)
Added setup.py and uploaded v0.1 to pypi
1 parent 241723e commit b5b1f98

5 files changed

Lines changed: 36 additions & 1 deletion

File tree

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,8 @@ docs/_templates/*
1313

1414
# pytest output
1515
.pytest_cache
16+
17+
# pypi package output
18+
build/
19+
dist/
20+
mATLASplotlib.egg-info/

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include README.md

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ mATLASplotlib
77
:target: https://landscape.io/github/jemrobinson/mATLASplotlib/master
88
:alt: Code Health
99

10-
This package provides wrappers around matplotlib functionality to allow plots compatible with the ATLAS style guidelines for users who are not familiar with matplotlib syntax.
10+
This package provides wrappers around matplotlib functionality produce plots compatible with the style guidelines for the ATLAS experiment at the LHC.
11+
It is particularly aimed at users who are not familiar with matplotlib syntax.
1112
Basic usage involves creating a canvas, plotting a dataset and saving the output to a file.
1213
For example, something like
1314

pypi_upload.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#! /bin/bash
2+
3+
# Create package
4+
python setup.py sdist bdist_wheel
5+
6+
# Upload to pypi (use --repository-url https://test.pypi.org/legacy/ for testing)
7+
twine upload dist/*
8+
9+
# Remove temporary files
10+
rm -rf build/ dist/

setup.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
from setuptools import find_packages, setup
2+
3+
with open("README.md", "r") as f_readme:
4+
long_description = f_readme.read()
5+
6+
setup(
7+
name = "mATLASplotlib",
8+
version = "0.1",
9+
description = "Wrappers around matplotlib functionality to produce plots compatible with the style guidelines for the ATLAS experiment at the LHC",
10+
long_description = long_description,
11+
long_description_content_type = "text/markdown",
12+
url = "https://github.com/jemrobinson/mATLASplotlib",
13+
author = "James Robinson",
14+
author_email = "james.em.robinson@gmail.com",
15+
license = "GPLv3",
16+
install_requires = ["matplotlib", "numpy", "scipy"],
17+
packages = find_packages(),
18+
)

0 commit comments

Comments
 (0)