Skip to content

Commit

Permalink
Release 0.1.0 (#32)
Browse files Browse the repository at this point in the history
* Release 0.1.0

* Add installation instructions to README
  • Loading branch information
eigenfoo authored Jan 20, 2020
1 parent c769dd9 commit 1584054
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 2 deletions.
6 changes: 6 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
recursive-include docs *
include *.md
include requirements.txt
include LICENSE.txt
include LICENSE.pymc3.txt
include LICENSE.pymc4.txt
12 changes: 11 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.DEFAULT_GOAL = help

PYTHON := python
PYTHON := python3
PIP := pip
CONDA := conda
SHELL := bash
Expand Down Expand Up @@ -83,3 +83,13 @@ clean: # Clean project directories.
find littlemcmc/ tests/ -type d -name "__pycache__" -delete
find littlemcmc/ tests/ -type f -name "*.pyc" -delete
${MAKE} -C docs/ clean

.PHONY: package
package: clean # Package glaze in preparation for releasing to PyPI.
${PYTHON} setup.py sdist bdist_wheel
twine check dist/*
@printf "\n\n\033[1;34mTo upload to Test PyPI (recommended!), run:\033[0m\n\n"
@printf "\t\033[1;34mpython3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*\033[0m\n\n"
@printf "\033[1;34mTo upload to PyPI, run:\033[0m\n\n"
@printf "\t\033[1;34mpython3 -m twine upload dist/*\033[0m\n\n"
@printf "\033[1;34mYou will need PyPI credentials.\033[0m\n\n"
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
> out of [the PyMC project](https://github.com/pymc-devs). Not to be confused
> with [minimc](https://github.com/ColCarroll/minimc).
## Installation

The latest release of LittleMCMC can be installed from PyPI:

```bash
pip install littlemcmc
```

## License

LittleMCMC is modified from [the PyMC3 and PyMC4
Expand Down
5 changes: 5 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ pytest
pytest-cov
pytest-html

# Packaging requirements
setuptools
twine
wheel

# Sphinx requirements
numpydoc
sphinx
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
DESCRIPTION = "A lightweight and performant implementation of HMC and NUTS in Python, spun out of the PyMC4 project."
AUTHOR = "George Ho"
AUTHOR_EMAIL = "[email protected]"
URL = ("https://github.com/eigenfoo/littlemcmc",)
URL = "https://github.com/eigenfoo/littlemcmc"
LICENSE = "Apache License, Version 2.0"

CLASSIFIERS = [
Expand Down

0 comments on commit 1584054

Please sign in to comment.