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 to latest best practices #1

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
fd4924b
refactor: migrate to copier template by browniebroke
ypid May 4, 2024
a849f27
refactor: get it working after applying the template
ypid May 9, 2024
c00d460
refactor: [DATALAD RUNCMD] run ruff linter over all files (safe mode)
ypid May 9, 2024
387b060
refactor: drop commented out/unused import
ypid May 9, 2024
a640ce1
style: [DATALAD RUNCMD] run black formatter on all files
ypid May 9, 2024
d7b49e7
chore: drop legacy to avoid having it formatted by pre-commit hooks
ypid May 9, 2024
b37b6f5
chore: remove FUNDING.yml that was created by copier template
ypid May 9, 2024
8be15cd
chore: remove unused link because of false positive by codespell
ypid May 9, 2024
5d1368d
style: [DATALAD RUNCMD] run prettier over all files
ypid May 9, 2024
661c8ff
ci: remove outdated and failing .gitlab-ci.yml for now, rewrite it later
ypid May 9, 2024
60d4ce3
test: disable mypy because code does not yet declare types
ypid May 9, 2024
0ba2016
test: install commit-msg hook by default to ensure that commitizen runs
ypid May 9, 2024
7a074f7
chore: hash lock pre-commit repos
ypid May 9, 2024
1f26aaa
docs: list sdrfnord as original author in pyproject.toml
ypid May 9, 2024
c182c18
docs: add myself as maintainer in pyproject.toml
ypid May 9, 2024
60c1561
ci: remove GitHub CI for now until I run the tests locally
ypid May 9, 2024
2af455e
fix: do not auto close issues by bot because I don‘t like that
ypid May 9, 2024
d26d6b6
ci: do not manage GitHub labels from CI for now
ypid May 9, 2024
7b19229
ci: do not upgrade poetry using CI for now
ypid May 9, 2024
0449903
docs: remove README that the copier template generated
ypid May 9, 2024
a2d63ff
chore: license property sets the license classifier automatically
ypid May 9, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"projectName": "fdeunlock",
"projectOwner": "ypid",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 80,
"commit": true,
"commitConvention": "angular",
"contributors": [],
"contributorsPerLine": 7,
"skipCi": true
}
21 changes: 21 additions & 0 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Changes here will be overwritten by Copier
_commit: 292018d
_src_path: https://github.com/browniebroke/pypackage-template
add_me_as_contributor: false
cli_name: fdeunlock
copyright_year: 2013-2016,2017,2024
documentation: false
email: [email protected]
full_name: Robin Schneider
github_username: ypid
has_cli: true
initial_commit: false
open_source_license: GNU General Public License v3
package_name: fdeunlock
project_name: FDEunlock
project_short_description: Check and unlock full disk encrypted systems via ssh
project_slug: fdeunlock
run_poetry_install: false
setup_github: false
setup_pre_commit: true

21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
charset = utf-8
end_of_line = lf

[*.bat]
indent_style = tab
end_of_line = crlf

[LICENSE]
insert_final_newline = false

[Makefile]
indent_style = tab
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Bug report
about: Create a report to help us improve
labels: bug
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

**Additional context**
Add any other context about the problem here.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature request
about: Suggest an idea for this project
labels: enhancement
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Additional context**
Add any other context or screenshots about the feature request here.
93 changes: 81 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
tests/coverage-report
playground
dist_signed/
# *.check_idempotency

*.tmp

# Created by .ignore support plugin (hsz.mobi)
### Python template
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand All @@ -15,7 +10,6 @@ __pycache__/

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
Expand All @@ -27,9 +21,12 @@ lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
Expand All @@ -44,28 +41,100 @@ pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

#Ipython Notebook
# Jupyter Notebook
.ipynb_checkpoints
## For quick testing.
## Generated by https://github.com/ypid/ypid-ansible-common/blob/master/bin/sphinx-debops-role-build

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder {{package_name}} settings
.spyderproject
.spyproject

# Rope {{package_name}} settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/
51 changes: 0 additions & 51 deletions .gitlab-ci.yml

This file was deleted.

8 changes: 8 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
tasks:
- command: |
pip install poetry
PIP_USER=false poetry install
- command: |
pip install pre-commit
pre-commit install
PIP_USER=false pre-commit install-hooks
9 changes: 9 additions & 0 deletions .idea/fdeunlock.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

65 changes: 65 additions & 0 deletions .idea/watcherTasks.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 32 additions & 0 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading