project: create project base and setup build system

Author: zefr0x

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# This Github workflow will create a new release when a tag is pushed.
+
+name: release
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+  create-release:
+    name: create-release
+    runs-on: ubuntu-latest
+    outputs:
+      upload_url: ${{ steps.release.outputs.upload_url }}
+      version: ${{ github.ref_name }}
+    steps:
+      - name: Create Github Release
+        id: release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref_name }}
+          release_name: ${{ github.ref_name }}

.gitignore

@@ -0,0 +1,5 @@
+.mypy_cache
+__pycache__
+builddir
+.coverage
+htmlcov

.pre-commit-config.yaml

@@ -0,0 +1,75 @@
+ci:
+  skip: [pip-compile]
+
+repos:
+  # General
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-xml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: name-tests-test
+      - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        args:
+          - "--check-untyped-defs"
+          - "--ignore-missing-imports"
+        additional_dependencies:
+          - PyGObject-stubs
+          - name-that-hash
+  # Python
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - pep8-naming
+          - "git+https://github.com/zer0-x/flake8-typehinting#egg=flake8-typehinting"
+          - flake8-builtins
+          - flake8-bugbear
+          - flake8-comprehensions
+  - repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+      - id: black
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.12.0
+    hooks:
+      - id: reorder-python-imports
+  - repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.3.0
+    hooks:
+      - id: pydocstyle
+  # Prettier
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        types_or: [markdown, css]
+  - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+    rev: v2.12.0
+    hooks:
+      - id: pretty-format-ini
+  # PIP requirements
+  - repo: https://github.com/jazzband/pip-tools
+    rev: 7.3.0
+    hooks:
+      - id: pip-compile
+        name: pip-compile requirements.in
+        args:
+          - --resolver=backtracking
+          - --generate-hashes
+          - requirements/requirements.in
+        files: ^requirements/requirements.in$
+      - id: pip-compile
+        name: pip-compile requirements-dev.in
+        args:
+          - --resolver=backtracking
+          - --generate-hashes
+          - requirements/requirements-dev.in
+        files: ^requirements/requirements-dev.in$

CHANGELOG.md

@@ -0,0 +1 @@
+# Unreleased

CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# Contributing
+
+## Bug report
+
+For now [GitHub bug traker](https://github.com/zefr0x/hash_identifier/issues) is used for this project.
+
+We aim to be user friendly, so if you have any issue or suggestion for the [UI](https://en.wikipedia.org/wiki/User_interface_design)/[UX](https://en.wikipedia.org/wiki/User_experience_design) or about the [application packging](<https://en.wikipedia.org/wiki/Package_(package_management_system)>), please tell us, we appreciate it.
+
+## Development
+
+- The 3rd version of the [Python](<https://en.wikipedia.org/wiki/Python_(programming_language)>) programming language is used mainly in this project.
+- Dependencies managment is handled using [requirements files](requirements) with [pip-tools](https://pip-tools.rtfd.io/).
+  - `requirements.in` contain requirements for running the application and `requirements-dev.in` contain requirements for development.
+  - `.txt` files are locked requirements with hashes generated using `pip-tools` to provide a reproducible environment.
+  - For development you will need to use both files, while users just need to use the `requirements.txt` file.
+
+> `pre-commit` will take care about generating `.txt` files. You should just edit `.in` files or use `pip-tools` to upgrade locked requirements.
+
+### Create a virtual environment and install dependencies
+
+First clone the git repository:
+
+```
+git clone https://github.com/zefr0x/hash_identifier.git
+```
+
+For development you are recomended to use [pip-tools](https://pip-tools.rtfd.io/) for reproducing the same environment.
+
+1. Create a virtual environment and activate it
+
+```shell
+virtualenv .env
+
+source .env/bin/activate
+```
+
+2. Install `pip-tools` in the virtualenv
+
+```shell
+pip install pip-tools
+```
+
+3. Run the folowing command in the project's root directory to install all the dependencies for development
+
+```shell
+pip-sync requirements/{requirements,requirements-dev}.txt
+```
+
+4. Then you can run the application as a python module
+
+```shell
+python3 -m hash_identifier
+```
+
+> You can use the [`justfile`](https://github.com/casey/just) if you want to.
+
+### Style
+
+- You should [type hint](https://docs.python.org/3/library/typing.html) every thing as possible.
+- You should comment every thing to keep the code easy to read. Every file, every class, every function and any line that need a comment.
+
+You should use:
+
+- [mypy](http://www.mypy-lang.org/) `(Static Type Checker)`
+- [flake8](https://flake8.pycqa.org/) `(Style Enforcer)`
+- [pydocstyle](https://www.pydocstyle.org/) `(Checking compliance with Python docstring conventions)`
+- [black](https://black.readthedocs.io/) `(Code Formatter)`
+
+You can also use any tool that you want as long as it's compatable with the required style.
+
+#### Installing `pre-commit`
+
+To make every thing easy [**`pre-commit`**](https://pre-commit.com/) is used in this project, it should run in every commit, so you shouldn't commit any thing without checking it first.
+
+First install it:
+
+```shell
+pip install pre-commit
+```
+
+> You can use another way to install it, maybe from your OS's package manager.
+
+Then add it as a git hook while you are inside the repository:
+
+```shell
+pre-commit install
+```
+
+## Testing
+
+TODO...
+
+## Translation
+
+The application's GUI is prepared for [internationalisation](https://en.wikipedia.org/wiki/Internationalization_and_localization) using [gettext](https://en.wikipedia.org/wiki/Gettext).
+
+Go to the [`./po`](./po) directory for more details.
+
+### Translating the application name
+
+The name of the application should be changed with respect to the target locale, but it must convey the same meaning.