Why not make a pip package? about minigrid HOT 8 CLOSED

Until there's a package, this seems to work just fine if you want a single command install that also works with virtualenv config files: pip install git+git://github.com/maximecb/gym-minigrid.git#egg=gym-minigrid

from minigrid.

I added you to both repositories!

I think this issue can be closed :)

from minigrid.

The problem is that other dependencies can be a moving target, something can still break even with pip packages. Though I agree this might help alleviate the problem.

How much work is it to create a pip package?

from minigrid.

You need to create an account on pypi, create a setup.py file, execute a command to build and another one to upload. This is detailed here: https://packaging.python.org/tutorials/packaging-projects/.

I don't know how long it takes, but I assume it takes a little bit of time the first time, and quite nothing after.

from minigrid.

I have just created a package for torch-rl. The process can seem complicated but it is in fact very simple (it took me 5 minutes to do it).

1. Create an account on https://pypi.org/account/register/
2. Install some packages pip3 install --upgrade setuptools wheel twine
3. In the root of the package, execute python3 setup.py sdist bdist_wheel to build it.
4. In the root of the package, execute twine upload dist/* to upload it.

Your package should be live at https://pypi.org/project/gym-minigrid/ .

I think it is worth to create a PyPI package because it will be easier for people to use it. Moreover, it is easy to version your package by changing the version in setup.py.

from minigrid.

I have just released that I could create the package for you (by executing the commands in the previous post). Hence, I created it. The package is now here: https://pypi.org/project/gym-minigrid/.

If you create an account to PyPI, I will add you as the owner of the package on PyPI.

I think you will also have to add:

build/*
dist/*

to your .gitignore.

Edit: I also did the same thing for gym-miniworld. The package is now here: https://pypi.org/project/gym-miniworld/ . I think you should also edit the .gitignore of this repository.

from minigrid.

Thanks @lcswillems, I registered account maximecb on pipy and added those items to the .gitignore.

from minigrid.

Awesome, thanks.

from minigrid.