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

Reorganize repo as a Python library #1

Closed
akariv opened this issue Apr 12, 2020 · 6 comments
Closed

Reorganize repo as a Python library #1

akariv opened this issue Apr 12, 2020 · 6 comments

Comments

@akariv
Copy link
Member

akariv commented Apr 12, 2020

So that it can be installed from pip

@ronniemaor
Copy link
Collaborator

I'm actually not sure what is required in order to make this pip installable. Can you provide more details and/or an example project?

@RoySegall
Copy link

RoySegall commented Apr 12, 2020

If someone need help with this one - I'm here

@ronniemaor
Copy link
Collaborator

If someone need help with this one - I'm here

Yep, would love some guidance on how to make this pip installable. A simple reference project would also help a lot.

@RoySegall
Copy link

Well - You can have a look here - https://packaging.python.org/tutorials/packaging-projects/. Also, this one looks promising - https://github.com/audreyr/cookiecutter-pypackage.

Generally, After setting up the project structure you'll need to work on the package in a dev mode. All you need to do is (in the project's folder of course):
pip install . -e

This will ensure that any changes that you made will reflect to the pip packages (or to your virtualenv). This generally how I'm developing my packages. You can also look on this package I created, just so you could any reference and see I set my Travis incase cookie cutter set up something wrong.

@akariv
Copy link
Member Author

akariv commented Apr 12, 2020

This is a good template to start with:

https://github.com/okfn/oki-py

@zivmaor
Copy link
Collaborator

zivmaor commented Apr 18, 2020

Took a lot of mucking around, trial and error, but seems to be working now + integrated with travis and coveralls. Tox still not working on my local env (pycharm on windows) but not sure it's a blocker.

@zivmaor zivmaor closed this as completed Apr 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants