Skip to content

Commit

Permalink
Packaging and distribute to PyPI (#1)
Browse files Browse the repository at this point in the history
* publish v1.0.3
* add installation
  • Loading branch information
SSARCandy authored Feb 8, 2018
1 parent ea7cb11 commit 3111b94
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
MANIFEST

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
File renamed without changes.
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include README.md
include LICENSE.txt
include breakout_env/assets/*.npy
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ A [gym](https://github.com/openai/gym/blob/master/gym/envs/atari/atari_env.py) l

\* `len(bricks_color)` and `len(bricks_color)` should equal to `bricks_rows`.

<!-- ## Installation
## Installation

Install from PyPI:

```sh
$ pip install <>
$ pip install breakout_env
```

Install from master branch

```sh
$ pip install git+https://github.com/SSARCandy/breakout-env.git@master
``` -->
```

## Example

Expand Down
2 changes: 1 addition & 1 deletion breakout_env/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
A configurable Breakout environment for reinforcement learning
"""

__version__ = '1.0.0'
__version__ = '1.0.3'

from .breakout_env import Breakout

Expand Down
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[metadata]
description-file = README.md
22 changes: 22 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
from setuptools import setup, find_packages

def read_readme():
with open('README.md') as f:
return f.read()

setup(
name = 'breakout_env',
packages=find_packages(),
version='1.0.3',
description = 'A configurable Breakout environment for reinforcement learning',
long_description = read_readme(),
author = 'SSARCandy',
author_email = '[email protected]',
license = 'MIT',
url = 'https://github.com/SSARCandy/breakout-env', # use the URL to the github repo
# download_url = 'https://github.com/SSARCandy/breakout-env/archive/1.0.0.tar.gz', # I'll explain this in a second
keywords = ['game', 'learning', 'evironment'], # arbitrary keywords
classifiers = [],
install_requires=['numpy>=1.1', 'distribute'],
include_package_data=True
)

0 comments on commit 3111b94

Please sign in to comment.