Skip to content

Commit

Permalink
Register project with pypi (#5)
Browse files Browse the repository at this point in the history
Added setup.py and uploaded v0.1 to pypi
  • Loading branch information
jemrobinson authored Jun 27, 2018
1 parent 241723e commit b5b1f98
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ docs/_templates/*

# pytest output
.pytest_cache

# pypi package output
build/
dist/
mATLASplotlib.egg-info/
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include README.md
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ mATLASplotlib
:target: https://landscape.io/github/jemrobinson/mATLASplotlib/master
:alt: Code Health

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.
This package provides wrappers around matplotlib functionality produce plots compatible with the style guidelines for the ATLAS experiment at the LHC.
It is particularly aimed at users who are not familiar with matplotlib syntax.
Basic usage involves creating a canvas, plotting a dataset and saving the output to a file.
For example, something like

Expand Down
10 changes: 10 additions & 0 deletions pypi_upload.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#! /bin/bash

# Create package
python setup.py sdist bdist_wheel

# Upload to pypi (use --repository-url https://test.pypi.org/legacy/ for testing)
twine upload dist/*

# Remove temporary files
rm -rf build/ dist/
18 changes: 18 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
from setuptools import find_packages, setup

with open("README.md", "r") as f_readme:
long_description = f_readme.read()

setup(
name = "mATLASplotlib",
version = "0.1",
description = "Wrappers around matplotlib functionality to produce plots compatible with the style guidelines for the ATLAS experiment at the LHC",
long_description = long_description,
long_description_content_type = "text/markdown",
url = "https://github.com/jemrobinson/mATLASplotlib",
author = "James Robinson",
author_email = "james.em.robinson@gmail.com",
license = "GPLv3",
install_requires = ["matplotlib", "numpy", "scipy"],
packages = find_packages(),
)

0 comments on commit b5b1f98

Please sign in to comment.