Merge pull request #3 from EGAMAGZ/development

First release

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.tcss]
+charset = utf-8
+indent_size = 4
+trim_trailing_whitespace = true
+indent_style = space
+end_of_line = crlf
+insert_final_newline = true

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+# Pull Request
+
+What this pull request changes...
+
+- Change 1
+- Change 2
+
+**Issues fixed with this pull request...**
+
+- Issue 1
+- Issue 2
+
+**Optionally, what changes should join this PR..**
+
+- Change Docs

.github/workflows/linter.yml

@@ -0,0 +1,49 @@
+name: Linting and type checking
+
+on:
+  pull_request:
+    branches: [master]
+  push:
+    branches: [master]
+
+jobs:
+  check-linting:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.12']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry 
+          poetry install
+      - name: Run Ruff
+        run: poetry run ruff check
+  check-typing:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.12']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry 
+          poetry install
+      - name: Run Mypy
+        run: poetry run mypy ignori

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to Pypi
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+      - name: Install dependencies
+        run: poetry install --no-root --without dev test
+      - name: Publish to Pipy
+        env:
+          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}
+        run: poetry publish --build --username __token__ --password $POETRY_PYPI_TOKEN_PYPI

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Tests
+
+on:
+  pull_request:
+    branches: [master]
+  push:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.12', '3.11']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry and dependencies
+        run:  |
+          python -m pip install --upgrade pip
+          pip install poetry
+      - name: Install dependencies
+        run: poetry install --no-root
+      - name: Run Tests
+        run: poetry run tox

.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+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
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.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/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project 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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "ms-python.mypy-type-checker",
+        "charliermarsh.ruff"
+    ]
+}

.vscode/settings.json

@@ -1,3 +1,8 @@
 {
-    "python.analysis.typeCheckingMode": "basic"
+    "python.analysis.typeCheckingMode": "basic",
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
 }

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing to Ignori
+
+## How to commit
+
+Please put a meaningful commit message following the specification of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Some examples of messages:
+
+### **OK:**
+
+* Fixed issue#301 - Tasks searched aren't displayed
+* Formatted with black
+* Fixed README
+* Updated requirements.txt
+
+### **Not OK:**
+
+* Pushed code
+* A bug fixed
+* Hacktober fest commit
+
+## Every unit test and functional test must have pass
+
+If you make a pull request and a unit test or functional test fails, please correct the problem and add it to the pull request.
+
+### **Note**
+
+* If your changes modify existing functions, you may need to edit the test itself to reflect them.
+* If you are adding a new function, please add unit tests or functional tests and confirm that they pass as well.
+
+## Who can contribute?
+
+Anyone is free to contribute :3.

README.md

@@ -0,0 +1,22 @@
+# Ignori
+
+[![PyPI](https://img.shields.io/pypi/v/ignori)](https://pypi.org/project/ignori/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ignori)
+![GitHub License](https://img.shields.io/github/license/egamagz/ignori)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Generate .gitignore file without leaving the terminal.
+![Ignori screenshot](./assets/ignori_screenshoot.png "Ignori Screenshot")
+Ignori was built with [Textual](https://github.com/textualize/textual)
+
+## Why?
+
+Normally, when I start a project from scratch or the project initialiser does not generate a gitignore file, I have to search for it. With this, the workflow will not be interrupted by having to google it.
+
+## Credits
+
+Created by Gamaliel Garcia / [@EGAMAGZ](https://github.com/EGAMAGZ)
+
+## LICENSE
+
+[MIT License](./LICENSE)