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

Package maintenance #30

Merged
merged 12 commits into from
Mar 16, 2021
Merged

Package maintenance #30

merged 12 commits into from
Mar 16, 2021

Conversation

majabojarska
Copy link
Collaborator

@majabojarska majabojarska commented Mar 13, 2021

General package maintenance

Closes #20

  • Add missing new lines at end of .pylintrc and CONTRIBUTION.md.
  • Gitignore:
    • Common VS Code and JetBrains IDE user-specific stuff.
    • All __pycache__ dirs (**/__pycache__).
  • Delete and untrack all *.pyc files.
  • Reformat and improve some docstrings.
  • Remove some excessive comments, e.g. ## IMPORTS ## or # WIPE. The import section is clear and visible enough to not need such additional comment. Same with functions - docstrings do that job well.
  • Refactor and simplify CLI argument parsing.
  • Adapt setup.py to use pip requirement text files.
    • Create extra dev and corresponding requirements_dev.txt requirement text file. Can be installed via pip install -e .[dev] or from PyPI via pip install konsave[dev].
  • Remove "Dependencies" section from README.md - dependencies get installed automatically anyway.

Please squash on merge 😉.

@Prayag2
Copy link
Owner

Prayag2 commented Mar 16, 2021

I'm sorry I couldn't merge it before. I'm merging it now!

@Prayag2 Prayag2 merged commit 062ce23 into master Mar 16, 2021
@majabojarska majabojarska deleted the pkg_maintenance branch March 16, 2021 17:01
@majabojarska
Copy link
Collaborator Author

No rush. Thanks for reviewing 😉.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduce project guidelines: code style, docstring style, formatter, linter, etc.
2 participants