Skip to content

Commit

Permalink
update README and setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
brauls committed Jun 25, 2018
1 parent 6248121 commit 25f068c
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 3 deletions.
1 change: 1 addition & 0 deletions Pipfile
Expand Up @@ -12,6 +12,7 @@ coveralls = "*"
pytest-cov = "*"
twine = "*"
setuptools = "*"
wheel = "*"

[requires]
python_version = "3.6"
10 changes: 9 additions & 1 deletion Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 26 additions & 1 deletion README.md
Expand Up @@ -4,10 +4,12 @@
[![PyPI pyversions](https://img.shields.io/badge/python-3.6-blue.svg)](https://badge.fury.io/py/random-geometry-points)

# random-geometry-points

This module provides classes to generate random points on geometry surfaces.
These points can then be used as test data, e.g. to simulate measurements of a measurement device.

## Installation

You can install this module using pip globally
```bash
pip install random-geometry-points
Expand Down Expand Up @@ -64,7 +66,30 @@ print(random_circle_points)
```

## Documentation

Please take a look at the [Wiki](https://github.com/brauls/random-geometry-points/wiki) for a more detailed description. There you get more detailed information on how you can use the geometry classes, the meaning of the geometry parameters and error handling.

## Deployment

### Update packages

```pipenv update --dev setuptools wheel twine```

### Update ```setup.py```

Update the content of ```setup.py```, especially the version information.

### Build source archive and built distribution

```pipenv run python setup.py sdist bdist_wheel```

### Deploy to PyPi or TestPyPi to test things first

```pipenv run twine upload --skip-existing --repository-url https://test.pypi.org/legacy/ dist/*```

```pipenv run twine upload --skip-existing dist/*```

## Useful links
* [Configuring pipenv for Visual Studio Code](https://olav.it/2017/03/04/pipenv-visual-studio-code/)

* [Configuring pipenv for Visual Studio Code](https://olav.it/2017/03/04/pipenv-visual-studio-code/)
* [Packaging Python Projects](https://packaging.python.org/tutorials/packaging-projects/)
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -6,7 +6,7 @@

setup(
name="random_geometry_points",
version="1.0.0",
version="1.1.1",
description="Library to generate random points (2D or 3D) on geometry surfaces",
long_description=LONG_DESCRIPTION,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit 25f068c

Please sign in to comment.