Remove symlinks and add Pypi description

erdnaxe · Jun 8, 2020 · d8bb18a · d8bb18a
1 parent e880232
commit d8bb18a
Show file tree

Hide file tree

Showing 21 changed files with 29 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,5 +8,6 @@
 *.pyc
 .eggs
 .idea
+build
 dist
 *~
diff --git a/.travis.yml b/.travis.yml
@@ -1,11 +1,20 @@
 language: python
+
+sudo: false
+
 python:
   "3.8"
 
 cache:
   directories:
     - $HOME/.cache/pip
 
+install:
+  - python setup.py install
+
+script:
+  - echo
+
 deploy:
   provider: pypi
   edge: true # opt in to dpl v2

diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 [![Documentation Status](https://img.shields.io/readthedocs/kraby?style=flat-square)](https://kraby.readthedocs.io/en/latest/)
 [![License](https://img.shields.io/github/license/erdnaxe/kraby?style=flat-square)](LICENSE)
+[![Travis (.com)](https://img.shields.io/travis/com/erdnaxe/kraby?style=flat-square)](https://travis-ci.com/github/erdnaxe/kraby)
+[![PyPI](https://img.shields.io/pypi/v/gym_kraby?style=flat-square)](https://pypi.org/project/gym-kraby/)
 
 # Kraby
 

diff --git a/docs/index.md b/docs/index.md
@@ -37,7 +37,7 @@ These servomotors are similar to the more popular **Dynamixel AX-12**.
 
 An [OpenAI Gym](https://gym.openai.com/) environment is available.
 It uses [BulletPhysics](https://github.com/bulletphysics/bullet3) simulator
-with [an URDF description](https://github.com/erdnaxe/kraby/blob/master/urdf_description/hexapod.urdf) of the robot.
+with [an URDF description](https://github.com/erdnaxe/kraby/blob/master/gym_kraby/data/hexapod.urdf) of the robot.
 
 ---
 

diff --git a/docs/urdf_description.md b/docs/urdf_description.md
@@ -5,7 +5,7 @@ for representing a robot model. It has been developed
 by the Robotic Operating System project (ROS).
 
 Kraby URDF description is available at
-<https://github.com/erdnaxe/kraby/blob/master/urdf_description/hexapod.urdf>.
+<https://github.com/erdnaxe/kraby/blob/master/gym_kraby/data/hexapod.urdf>.
 
 ---
 
@@ -14,9 +14,9 @@ Kraby URDF description is available at
 To simplify URDF editing and to avoid input errors,
 the project uses Jinja2[^xacro] templates to generate the URDF.
 You may edit files under
-[urdf_description/src/](https://github.com/erdnaxe/kraby/tree/master/urdf_description/src)
+[gym_kraby/data/src/](https://github.com/erdnaxe/kraby/tree/master/gym_kraby/data/src)
 then execute
-[urdf_description/generate_urdf.py](https://github.com/erdnaxe/kraby/tree/master/urdf_description).
+[gym_kraby/data/generate_urdf.py](https://github.com/erdnaxe/kraby/tree/master/gym_kraby/data).
 
 [^xacro]: [Xacro](http://wiki.ros.org/xacro) could also be an option, but it
 requires to install the ROS toolchain.

diff --git a/gym_kraby/data b/gym_kraby/data
diff --git a/urdf_description/generate_urdf.py → gym_kraby/data/generate_urdf.py b/urdf_description/generate_urdf.py → gym_kraby/data/generate_urdf.py
diff --git a/urdf_description/hexapod.urdf → gym_kraby/data/hexapod.urdf b/urdf_description/hexapod.urdf → gym_kraby/data/hexapod.urdf
diff --git a/3d_parts/STL/box.stl → gym_kraby/data/meshes/box.stl b/3d_parts/STL/box.stl → gym_kraby/data/meshes/box.stl
diff --git a/3d_parts/STL/foot.stl → gym_kraby/data/meshes/foot.stl b/3d_parts/STL/foot.stl → gym_kraby/data/meshes/foot.stl
diff --git a/3d_parts/STL/joint.stl → gym_kraby/data/meshes/joint.stl b/3d_parts/STL/joint.stl → gym_kraby/data/meshes/joint.stl
diff --git a/urdf_description/src/hexapod.urdf.j2 → gym_kraby/data/src/hexapod.urdf.j2 b/urdf_description/src/hexapod.urdf.j2 → gym_kraby/data/src/hexapod.urdf.j2
diff --git a/...description/src/joints/joint_fixed.sdf.j2 → gym_kraby/data/src/joints/joint_fixed.sdf.j2 b/...description/src/joints/joint_fixed.sdf.j2 → gym_kraby/data/src/joints/joint_fixed.sdf.j2
diff --git a/...iption/src/joints/joint_servomotor.sdf.j2 → ...y/data/src/joints/joint_servomotor.sdf.j2 b/...iption/src/joints/joint_servomotor.sdf.j2 → ...y/data/src/joints/joint_servomotor.sdf.j2
diff --git a/urdf_description/src/links/box.sdf.j2 → gym_kraby/data/src/links/box.sdf.j2 b/urdf_description/src/links/box.sdf.j2 → gym_kraby/data/src/links/box.sdf.j2
diff --git a/urdf_description/src/links/endcap.sdf.j2 → gym_kraby/data/src/links/endcap.sdf.j2 b/urdf_description/src/links/endcap.sdf.j2 → gym_kraby/data/src/links/endcap.sdf.j2
diff --git a/urdf_description/src/links/foot.sdf.j2 → gym_kraby/data/src/links/foot.sdf.j2 b/urdf_description/src/links/foot.sdf.j2 → gym_kraby/data/src/links/foot.sdf.j2
diff --git a/urdf_description/src/links/joint.sdf.j2 → gym_kraby/data/src/links/joint.sdf.j2 b/urdf_description/src/links/joint.sdf.j2 → gym_kraby/data/src/links/joint.sdf.j2
diff --git a/urdf_description/src/links/servomotor.sdf.j2 → gym_kraby/data/src/links/servomotor.sdf.j2 b/urdf_description/src/links/servomotor.sdf.j2 → gym_kraby/data/src/links/servomotor.sdf.j2
diff --git a/setup.py b/setup.py
@@ -1,16 +1,24 @@
-from setuptools import setup, find_packages
+from setuptools import setup
+
+# read the contents of your README file
+from os import path
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
 
 setup(
     name='gym_kraby',
     author='Alexandre Iooss',
     author_email='erdnaxe@crans.org',
     license='GPLv3',
     url='https://kraby.readthedocs.io/',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     install_requires=[
         'gym',
         'pybullet',
     ],
-    packages=find_packages(),
+    packages=['gym_kraby'],
     package_data = {
         # Include URDF and associated STL
         'gym_kraby': ['data/*.urdf', 'data/meshes/*.stl'],
@@ -20,4 +28,7 @@
         "local_scheme": "no-local-version"
     },
     setup_requires=['setuptools_scm'],
+    classifiers=[
+        'Programming Language :: Python',
+    ],
 )
diff --git a/urdf_description/meshes b/urdf_description/meshes