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

Clean up packaging #95

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

floppym
Copy link

@floppym floppym commented Apr 29, 2020

Do not install 'examples' and 'tests' as root-level packages.
Remove commented code.
Include the manpage in the source tarball.

Do not install 'examples' and 'tests' as root-level packages.
Remove commented code.
Include the manpage in the source tarball.
@FelixSchwarz
Copy link

Thank you. Including the tests in the pypi tarball will also ease Fedora packaging once you have some more tests.

Btw: This is the biggest annoyance I have from a packaging point of view. Ideally I'd like to run the test suite and then push out updates without manual testing. Writing (offline) tests for an API client might be a bit challenging and somewhat pointless (as there is not much logic involved) but even some basic smoke tests would be nice.

@mahtin
Copy link
Collaborator

mahtin commented Feb 19, 2024

(and four years later - which does not mean I ignored this - kinda)

So it turns out that the tests folder was a really bad idea and #178 got triggered once I tried to focus on full test suites. There's other Python packages that also have tests folders which get installed in site-packages folder. Oops. The examples folder is still be installed there and I really this that should go somewhere else.

$ ls -d /opt/homebrew/lib/python3.11/site-packages/examples/
/opt/homebrew/lib/python3.11/site-packages/examples/
$

That's just not right; however, unlike tests the examples folder does not belong within the class folder. Let me think about this somewhat.

In regards to the man page for cli4; it's now correctly installed via this line:

        data_files=[('share/man/man1', ['cli4/cli4.1'])],

No idea how that works on Windows - I'd better check.

@mahtin
Copy link
Collaborator

mahtin commented May 8, 2024

I have not forgotten this.

  1. The tests folder is now under the CloudFlare folder.
  2. The examples has not been moved.
  3. The manual page still needs looking into.
    I did confirm that the tests folder was causing issues with other packages whom also use tests as a folder name. Oops!

I'll go focus on this again very soon.

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.

None yet

3 participants