From 631ad3cfda5d3d3cbf3b953d3faca24ab276b265 Mon Sep 17 00:00:00 2001
From: Ilija Vukotic <ivukotic@cern.ch>
Date: Tue, 4 Aug 2020 14:31:17 -0500
Subject: [PATCH] fix naming

---
 README.md                                        | 6 +++---
 TODO.md                                          | 1 -
 check_conformity.py                              | 8 ++++++++
 {gym-cache => gym_cache}/__init__.py             | 0
 {gym-cache => gym_cache}/envs/__init__.py        | 0
 {gym-cache => gym_cache}/envs/cache_continous.py | 0
 {gym-cache => gym_cache}/envs/cache_env.py       | 0
 {gym-cache => gym_cache}/envs/cache_env_full.py  | 0
 requirements.txt                                 | 3 ++-
 setup.py                                         | 4 ++--
 10 files changed, 15 insertions(+), 7 deletions(-)
 create mode 100644 check_conformity.py
 rename {gym-cache => gym_cache}/__init__.py (100%)
 rename {gym-cache => gym_cache}/envs/__init__.py (100%)
 rename {gym-cache => gym_cache}/envs/cache_continous.py (100%)
 rename {gym-cache => gym_cache}/envs/cache_env.py (100%)
 rename {gym-cache => gym_cache}/envs/cache_env_full.py (100%)

diff --git a/README.md b/README.md
index 81f5f2c..8675ef0 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-# gym_cache
+# gym-cache
 OpenAI based Gym environments for training RL caching agent
 
 install it:
 <code>
-   pip install gym_cache
+   pip install gym-cache
 </code> 
 
 import it like this:
@@ -63,7 +63,7 @@ To change environments:
    or
    <code>
    python setup.py bdist_wheel
-   python -m pip install dist\gym_cache-1.0.0-py3-none-any.whl
+   python -m pip install dist\gym_cache-1.0.1-py3-none-any.whl
    </code> 
 * to upload to pypi repository
    <code>
diff --git a/TODO.md b/TODO.md
index d7762e2..7ce1730 100644
--- a/TODO.md
+++ b/TODO.md
@@ -2,5 +2,4 @@
 add actor cleaning step: 
 * ask actor for decission to remove or not. List files in order of LRU. Signal to not learn is given in comment dict.
 
-register so it is pip installable.
 
diff --git a/check_conformity.py b/check_conformity.py
new file mode 100644
index 0000000..4381683
--- /dev/null
+++ b/check_conformity.py
@@ -0,0 +1,8 @@
+from stable_baselines.common.env_checker import check_env
+
+# env = CustomEnv(arg1, ...)
+# env = gym.make('gym_cache:Cache-v0')
+env = CacheEnv()
+
+# It will check your custom environment and output additional warnings if needed
+check_env(env)
diff --git a/gym-cache/__init__.py b/gym_cache/__init__.py
similarity index 100%
rename from gym-cache/__init__.py
rename to gym_cache/__init__.py
diff --git a/gym-cache/envs/__init__.py b/gym_cache/envs/__init__.py
similarity index 100%
rename from gym-cache/envs/__init__.py
rename to gym_cache/envs/__init__.py
diff --git a/gym-cache/envs/cache_continous.py b/gym_cache/envs/cache_continous.py
similarity index 100%
rename from gym-cache/envs/cache_continous.py
rename to gym_cache/envs/cache_continous.py
diff --git a/gym-cache/envs/cache_env.py b/gym_cache/envs/cache_env.py
similarity index 100%
rename from gym-cache/envs/cache_env.py
rename to gym_cache/envs/cache_env.py
diff --git a/gym-cache/envs/cache_env_full.py b/gym_cache/envs/cache_env_full.py
similarity index 100%
rename from gym-cache/envs/cache_env_full.py
rename to gym_cache/envs/cache_env_full.py
diff --git a/requirements.txt b/requirements.txt
index 3bb03df..10efe08 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -3,4 +3,5 @@ wheel
 tqdm
 twine
 pandas
-gym
\ No newline at end of file
+gym
+stable_baselines
\ No newline at end of file
diff --git a/setup.py b/setup.py
index 06e5810..521c27b 100644
--- a/setup.py
+++ b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='gym_cache',
-    version='1.0.1',
+    version='1.0.2',
     install_requires=[
         'gym>=0.2.3',
         'pandas>=0.24.2',
@@ -17,7 +17,7 @@
     description="gym environment simulating file cache.",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/ivukotic/gym_cache",
+    url="https://github.com/ivukotic/gym-cache",
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",