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

Update readme + add manifest for ansible files #109

Merged
merged 4 commits into from
Apr 9, 2018

Conversation

jrbalderrama
Copy link
Collaborator

No description provided.

setup.cfg Outdated
@@ -4,6 +4,7 @@ version = 1.0.0
description = Oslo messaging benchmarking orchestrator
keywords = benchmark, oslo messaging, RPC
license = GPL-3.0
license_file = LICENSE
Copy link
Owner

Choose a reason for hiding this comment

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

I pushed to testpypi and tested and it fails with :

$)  pip install ombt-orchestrator -i https://testpypi.python.org/pypi --no-deps
  Copying ombt_orchestrator.egg-info to build/bdist.macosx-10.9-x86_64/wheel/ombt_orchestrator-1.0.0-py2.7.egg-info
  running install_scripts
  error: [Errno 2] No such file or directory: 'LICENSE'

# maybe there is a better way to do it:
# https://stackoverflow.com/questions/1612733

recursive-include orchestrator/ansible *
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe add include LICENSE also

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

running python setup.py bdist_wheel looks good on my side now. I've renamed the licence file to fit the spec.

Copy link
Owner

Choose a reason for hiding this comment

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

include LICENSE.txt is necessary for the dist package to work.
Should we publish only wheels ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

wheels is based on the new spec but if for any reason a system only allows users to use former formats we can also include the licence in the manifest.

Copy link
Owner

Choose a reason for hiding this comment

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

ok

@@ -44,10 +44,8 @@ cd ombt-orchestrator
* Install the dependencies
Copy link
Owner

Choose a reason for hiding this comment

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

It seems that the README isn't rendered correctly on pypi, that's probably because it's written in md instead of rst.
Should we move to rst README format ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added in f856066 the proper type to the configuration, see: https://packaging.python.org/tutorials/distributing-packages/#description

Copy link
Owner

@msimonin msimonin Apr 9, 2018

Choose a reason for hiding this comment

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

once again 😺 👍 💡 !

@@ -9,6 +9,7 @@ url = https://github.com/msimonin/ombt-orchestrator/
author = Matthieu Simonin
author_email = matthieu.simonin@inria.fr
long_description = file: README.md
long_description_content_type = text/markdown
Copy link
Owner

@msimonin msimonin Apr 9, 2018

Choose a reason for hiding this comment

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

😺 👍 💡

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the PKG-INFO in the tgz file set the value properly: Description-Content-Type: text/markdown

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

twine>=1.11.0 and setuptools>=38.6.0 are required for Markdown support according to this: pypi/warehouse#869

@msimonin
Copy link
Owner

msimonin commented Apr 9, 2018

Great !

@msimonin msimonin merged commit 7f0b544 into msimonin:master Apr 9, 2018
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