Skip to content

Commit

Permalink
Added some files for pip
Browse files Browse the repository at this point in the history
  • Loading branch information
RedFT committed Apr 4, 2019
1 parent 06d920a commit ddc9d01
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ A library that makes working with a hexagonal lattice easier. Some of the inspir

## Getting Started

### Installing via pip

```bash
pip install hexy
```

### Dependencies

To install the dependencies run:
Expand All @@ -27,6 +33,12 @@ Go the project root directory and run the following:
python2 -m examples.example
```

If that doesn't work, then try:

```
python2 examples/example.py
```

The test app just shows off some features of the library. To play around you can:

```
Expand Down
1 change: 0 additions & 1 deletion __init__.py

This file was deleted.

3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Inside of setup.cfg
[metadata]
description-file = README.md
34 changes: 34 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
from distutils.core import setup
setup(
name = 'Hexy',
packages = ['hexy'],
version = '1.3',
license='MIT',
description = 'A library that makes working with a hexagonal lattice easier.',
author = 'Norbu Tsering',
author_email = 'norbu.tsering.cs@gmail.com',
url = 'https://github.com/redft/hexy',
download_url = 'https://github.com/RedFT/Hexy/archive/1.3.tar.gz',
keywords = ['hexy', 'coordinate', 'hexagon', 'hexagonal'],
install_requires=[
'atomicwrites==1.1.5',
'attrs==18.1.0',
'funcsigs==1.0.2',
'more-itertools==4.3.0',
'numpy==1.15.0',
'pathlib2==2.3.2',
'pluggy==0.7.1',
'py==1.5.4',
'pygame==1.9.4',
'pytest==3.7.0',
'scandir==1.7',
'six==1.11.0',
],
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Topic :: Software Development :: Libraries :: Python Modules',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 2',
],
)

0 comments on commit ddc9d01

Please sign in to comment.