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

Setup for release on PyPI #44

Merged
merged 5 commits into from
Sep 1, 2016
Merged

Setup for release on PyPI #44

merged 5 commits into from
Sep 1, 2016

Conversation

kba
Copy link
Contributor

@kba kba commented Aug 31, 2016

Once the tools are versioned (#43), they can be released to PyPI for easy installation with pip.

Uploading a source distribution basically works with the configuration in this PR.

Open Questions:

  • Name: hocr-tools with a dash is possible but if the project is properly packaged in the future (Make hocr-tools a proper module #42), it would be wise to have a name that is a valid module name That is not really a problem, seems to be fairly common actually.
  • What to put in author / author_email? I started with @tmbdev's credentials I removed the author_email, PyPI warns on register but still carries out the upload, at least for test.
  • Specify requirements in setup.py or in requirements.txt? Could be both, discussed here
  • Who manages the uploads? I will

@kba kba changed the title Add/extend setup.cfg/setup.py for release on PyPI Setup for release on PyPI Aug 31, 2016
@zuphilip
Copy link
Collaborator

Another advantage with requirements.txt is that the python docker "onbuild" is exactly looking for this.

(Later more on the other points...)

@kba
Copy link
Contributor Author

kba commented Aug 31, 2016

Another advantage with requirements.txt is that the python docker "onbuild" is exactly looking for this.

Good point. From what I understand, requirements.txt is more for defining a complete environment in which to run a project, whereas the requirements in setup.py define the minimum. pip will use the data in setup.py.

author = 'Thomas Breuel',
author_email = '[email protected]',
url = 'https://github.com/tmbdev/hocr-tools',
download_url = 'https://github.com/tmbdev/hocr-tools/tarball/' + VERSION,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need here the v as well, e.g. something like

https://github.com/zuphilip/hocr-tools/tarball/v0.3.2

which just redirects to

https://codeload.github.com/zuphilip/hocr-tools/legacy.tar.gz/v0.3.2

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed it.

description = 'Advanced tools for hOCR integration',
author = 'Thomas Breuel',
author_email = '[email protected]',
Copy link
Collaborator

@zuphilip zuphilip Sep 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might also make sense to add here

    maintainer = '',
    maintainer_email = '',

with the credentials of one of us. 😇 Do you volunteer @kba? We could also discuss this separately if you prefer.

@zuphilip
Copy link
Collaborator

zuphilip commented Sep 1, 2016

Perfect. Thank you! I will squash+merge in the next minutes.

@kba
Copy link
Contributor Author

kba commented Sep 1, 2016

Requirements are still open.

@zuphilip
Copy link
Collaborator

zuphilip commented Sep 1, 2016

Looks good for me. Let me know when it is ready to merge+squash.

@kba
Copy link
Contributor Author

kba commented Sep 1, 2016

It should work now, we can always improve it.

@zuphilip zuphilip merged commit 63956cb into ocropus:master Sep 1, 2016
kba added a commit to kba/hocr-tools that referenced this pull request Sep 15, 2016
@kba kba deleted the pypi-release branch September 15, 2016 14:51
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

Successfully merging this pull request may close these issues.

2 participants