Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release on PyPi #3

Open
michaelsilver opened this issue Jul 25, 2016 · 1 comment
Open

Release on PyPi #3

michaelsilver opened this issue Jul 25, 2016 · 1 comment

Comments

@michaelsilver
Copy link
Member

PyPi is the official Python Package Index. By uploading this library to PyPi, anyone in the world will be able to install it via pip install lispify instead of by cloning this repository. It's a nice thing to do since lispify is a generally useful library.

We should only release on PyPi once we are Python 3.x compatible (see #2).

Resources:

@michaelsilver
Copy link
Member Author

Additional step: since we are releasing this on PyPi, we need some form of documentation. Luckily, there's only one public function -- lispify. Our situation is similar to that of unidecode. Following their example, add a "demo" section to the README showing all the data types we can convert from Python --> Lisp. The demo should be a copy-paste of a session in the Python interpreter, just like in the Unidecode documentation.

When released on PyPi, make sure this "demo" is included on PyPi as well (don't know how this is done, needs to be Googled).

@chsamlee chsamlee removed the blocked label Jul 31, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants