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 .gitignore #664

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

stankudrow
Copy link

@stankudrow stankudrow commented Feb 15, 2025

The project ".gitignore" file is partially extended from the Python .gitignore template.

@caspervonb
Copy link
Collaborator

Any particular rationale for this pull request? e.g what's being accidentally included when working on the repository?

.ropeproject
.idea
# Byte-compiled / optimized / DLL files
__pycache__/
Copy link
Author

@stankudrow stankudrow Feb 18, 2025

Choose a reason for hiding this comment

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

Definitely to be ignored and so it be on top.

_examples/*
docs/*
*.egg
MANIFEST
Copy link
Author

Choose a reason for hiding this comment

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

May be removed, the project does not use it anyway.

.gitignore Outdated
Comment on lines 61 to 63
# IPython
profile_default/
ipython_config.py
Copy link
Author

Choose a reason for hiding this comment

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

This may be removed if you like.

Comment on lines +58 to +59
# Sphinx documentation
docs/_build/
Copy link
Author

Choose a reason for hiding this comment

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

I couldn't find what docs generator is preferred, so it may be here or I can remove it.

Comment on lines +126 to +127
# Visual Studio Code
.vscode/
Copy link
Author

Choose a reason for hiding this comment

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

.gitignore Outdated
Comment on lines 77 to 81
# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
#uv.lock
Copy link
Author

Choose a reason for hiding this comment

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

I'll remove uv for now because pipenv is in use.

Comment on lines +86 to +93
# Environments
.env
.venv
*__pycache__*
env/
venv/
ENV/
env.bak/
venv.bak/
Copy link
Author

Choose a reason for hiding this comment

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

Environments are grouped.

.gitignore Outdated
Comment on lines 95 to 103
# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site
Copy link
Author

Choose a reason for hiding this comment

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

May be removed.

Comment on lines +39 to +52
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
Copy link
Author

Choose a reason for hiding this comment

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

Looks good to have them grouped. The entries about nose testing framework may be removed.

@stankudrow
Copy link
Author

Any particular rationale for this pull request? e.g what's being accidentally included when working on the repository?

Hello.

I marked what I saw important of being noted. The rationale is to enrich/refresh the ".gitignore" file. It may be not so advantageous, but we can make it more similar to the more or less commonly adopted Python .gitignore template and without just having it copypasted completely.

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