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

tuf/api: Expose tuf.api as a package #1157

Conversation

woodruffw
Copy link
Contributor

This just adds tuf/api/__init__.py, turning it into a full package for distribution purposes.

  • The code follows the Code Style Guidelines
  • [N/A] Tests have been added for the bug fix or new feature
  • [N/A] Docs have been added for the bug fix or new feature

Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw
Copy link
Contributor Author

Amusingly this now breaks the CI, since tuf.api is now correctly discovered and linted 😉

@joshuagl
Copy link
Member

joshuagl commented Oct 1, 2020

According to the pylintrc docs

If the current working directory is in a Python module, Pylint searches up the hierarchy of Python modules until it finds a pylintrc file. This allows you to specify coding standards on a module-by-module basis. Of course, a directory is judged to be a Python module if it contains an __init__.py file.

I think we could add a pylintrc in tuf/api to support the style there?

@lukpueh
Copy link
Member

lukpueh commented Oct 1, 2020

I think we could add a pylintrc in tuf/api to support the style there?

That's actually a really good idea. The linter configuration would need a redo anyway even without style guide change (see in-toto/in-toto#296 (comment), which also applies here). But I'm reluctant to change the default pylintrc as it would require many fixes in code that won't survive the upcoming refactor.

If we create a new config in tuf/api we can use it for new code only and make it the default later. :)

@joshuagl
Copy link
Member

I've taken this change to a new PR which also adds a linter for tuf/api #1177

@joshuagl joshuagl closed this Oct 15, 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

Successfully merging this pull request may close these issues.

4 participants