release 0.0.4 (#37)

.github/workflows/linting.yml → .github/workflows/linting-and-formatting.yml

@@ -1,4 +1,4 @@
-name: linting
+name: linting-and-formatting
 
 on:
   pull_request:
@@ -7,11 +7,11 @@ on:
       - staging
 
 jobs:
-  linting-with-Ruff:
+  linting-and-formatting:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
@@ -20,6 +20,9 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install ruff
+    - name: Formatting
+      run: |
+         ruff format . --diff
     - name: Linting
       run: |
-        ruff check . --preview
+         ruff check . --output-file=github

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

.github/workflows/tests-suite.yml

@@ -14,7 +14,7 @@ jobs:
         python-version: ["3.9", "3.10", "3.11"]
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v4
       with:

.github/workflows/version.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Retrieve version from __version__.py
         run: |
           VERSION=$(awk -F"'" '/__version__/{print $2}' sequence/__version__.py)

CHANGELOG.md

@@ -9,21 +9,38 @@
 - ENHANCEMENT: Improvements to existing features that do not introduce new functionality
 - FEATURE: New features added to enhance functionality
 - FIX: Resolved issues, bugs, or unexpected behavior
+- MAINTENANCE: Changing, modifying, and updating the code to keep up with user needs
 - REMOVED: Features or functionalities removed from the project
 
 ### Version Policy
 
 The version is represented by three digits: a.b.c.
 - Bump the first digit (a) for an API_CHANGE.
 - Bump the second digit (b) for a FEATURE or a critical FIX.
-- Bump the third digit (c) for an ENHANCEMENT or a small FIX.
+- Bump the third digit (c) for an ENHANCEMENT, MAINTENANCE or a small FIX.
 - Once a digit is bumped, set all the digits to its right to zero.
 
 ---
 ## Unreleased
 
 ---
 
+## [0.0.4] - 2024-03-25
+
+ENHANCEMENT:
+- README.md: improve description
+- examples.solving_project_euler_problems: add notebook to present and explain the package functionalities
+
+FIX:
+- sequentium.sequence.core.utils.validation: Fix validate_positive_integer. Added flag when 0 is allowed.
+
+MAINTENANCE:
+- ruff.toml: deleted
+- tests.pytest.ini: deleted
+- pyproject.toml: added with the config of ruff.toml and pytest.ini
+- .github.workflows.linting-and-formatting: renamed and add checks also for the tests directory
+
+
 ## [0.0.3] - 2024-02-22
 
 ENHANCEMENT:
@@ -34,6 +51,7 @@ ENHANCEMENT:
 FIX:
 - sequentium.sequence.cli: fixed small bugs and unexpected behavior for the cli
 
+
 ## [0.0.2] - 2024-01-07
 
 ENHANCEMENT:
@@ -60,6 +78,7 @@ ENHANCEMENT:
 - sequentium.sequence.sequences.integer.explicit.py: added sequence A051876 (icositetragonal numbers)
 - sequentium.sequence.sequences.integer.explicit.py: added sequence A167149 (myriagonal numbers)
 
+
 ## [0.0.1] - 2024-01-02
 
 ENHANCEMENT:
@@ -74,6 +93,7 @@ ENHANCEMENT:
 FIX:
 - sequentium.core.core.py: method __getitem__ return a generator when the stop value in the slice is missing
 
+
 ## [0.0.0] - 2023-12-28
 
 First version of Sequentium :-D 

README.md

@@ -1,20 +1,28 @@
 # Sequentium
 
----
+![GitHub Release](https://img.shields.io/github/v/release/vascoSch92/sequentium)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sequentium)
 [![Downloads](https://static.pepy.tech/badge/sequentium)](https://pepy.tech/project/sequentium)
 ![PyPI - License](https://img.shields.io/pypi/l/sequentium)
 [![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg?style=flat)](https://www.firsttimersonly.com/)
+![Static Badge](https://img.shields.io/badge/Linting%20-%20passing%20-%20green?style=flat&logo=ruff&label=Linted%20with%20Ruff&color=blue)
+[![tests-suite](https://github.com/VascoSch92/sequentium/actions/workflows/tests-suite.yml/badge.svg?branch=main)](https://github.com/VascoSch92/sequentium/actions/workflows/tests-suite.yml)
 ---
 
 Sequentium is a user-friendly package that implements various well-known sequences, 
 providing a seamless and intuitive experience for the user.
 
-For an exhaustive list of all sequences implemented in Sequentium, 
-please click [here](https://github.com/VascoSch92/sequentium/blob/main/sequence/SEQUENCES_LIST.md).
+- 💻 - installabe via pip
+- 🐍 - compatible with Python 3.9, 3.10, 3.11 and 3.12
+- 📈 - +50 sequences already coded. Click [here](https://github.com/VascoSch92/sequentium/blob/main/sequence/SEQUENCES_LIST.md) for a complete list
+- 👍 - intuitive API
+- ✅ - accurately tested
+
 
 If you would like to contribute to the project, take a look to the section [_How to contribute_](https://github.com/VascoSch92/sequentium/wiki/5.-How-to-contribuite) in the wiki.
 
+For some practical examples on how to use Sequentium, take al look [_here_](https://github.com/VascoSch92/sequentium/examples).
+
 ## Quick start
 
 To install Sequentium, use the following command: