# Sequentium
---
[](https://pepy.tech/project/sequentium)
[](https://www.firsttimersonly.com/)
---
Sequentium is a user-friendly package that implements various well-known sequences,
providing a seamless and intuitive experience for the user.
- 💻 - 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:
```shell
pip install sequentium
```
Suppose you want to work with the Fibonacci sequence. First, import it into your script:
```python
from sequence import FibonacciSequence
fibonacci = FibonacciSequence()
```
Now, FibonacciSequence is a class representing the Fibonacci sequence. It behaves similarly to a list.
You can iterate through it:
```python
for x in fibonacci:
print(x)
>> 0, 1, 1, 2, 3, 5, 8, 13, 21,...
```
Or you can access a specific term directly:
```python
fibonacci[8]
>> 21
```
Slicing is also supported:
```python
fibonacci[2:8]
>> [1, 2, 3, 5, 13]
```
Additionally, you can check if a number appears in the `Fibonacci sequence`:
```python
7 in fibonacci
>> False
21 in fibonacci
>> True
```
## Command Line Interface (CLI)
Sequentium provides a Command Line Interface (CLI) for convenient usage from your terminal.
```text
usage: Sequentium [-h] [-v] [--list {integer,generalised} [{integer,generalised} ...]] [-a AT] [-l] [--start START] [--stop STOP] [--step STEP] [-c CONTAINS] [sequence]
Sequentium is a user-friendly package that implements various well-known sequences, providing a seamless and intuitive experience for the user
positional arguments:
sequence Specify the name or identifier of the sequence to operate on.
options:
-h, --help show this help message and exit
-v, --version Display the version information.
--list {integer,generalised} [{integer,generalised} ...]
List of implemented sequences.
sequence options:
-a AT, --at AT Retrieve the term at the specified index in the sequence.
-l, --length Display the length of the sequence.
--start START Define the starting point of the sequence.
--stop STOP End point of the sequence (excluded).
--step STEP Step size for iterating through the sequence.
-c CONTAINS, --contains CONTAINS
Check if the sequence contains a specific value.
For help with a specific command, see: `sequence help <command>`
```
Here are some examples illustrating the usage of the Sequentium CLI:
- specify the index to get a specific element of `FibonacciSequence`
```text
sequence FibonacciSequence --at 8
>> 21
```
- define a range of `FibonacciSequence` using start and stop parameters
```text
sequence FibonacciSequence --start 2 --stop 8
>> [1, 2, 3, 5, 8, 13]
```
- check if a particular number belongs to the `FibonacciSequence`
```text
sequence FibonacciSequence --contains 7
>> False
sequence FibonacciNumbers --contains 21
>> True
```
Raw data
{
"_id": null,
"home_page": "https://github.com/VascoSch92/sequentium",
"name": "sequentium",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "math, mathematics, sequence, fibonacci",
"author": "Vasco Schiavo",
"author_email": "vasco.schiavo@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/f9/db/123b46541e37b3144efbf68ef245dad3701c35d9d1ed30c3bc3e0ad34abd/sequentium-0.0.5.tar.gz",
"platform": null,
"description": "# Sequentium\n\n---\n\n\n[](https://pepy.tech/project/sequentium)\n \n[](https://www.firsttimersonly.com/)\n\n---\n\nSequentium is a user-friendly package that implements various well-known sequences, \nproviding a seamless and intuitive experience for the user.\n\n- \ud83d\udcbb - installabe via pip\n- \ud83d\udc0d - compatible with Python 3.9, 3.10, 3.11 and 3.12\n- \ud83d\udcc8 - +50 sequences already coded. Click [here](https://github.com/VascoSch92/sequentium/blob/main/sequence/SEQUENCES_LIST.md) for a complete list\n- \ud83d\udc4d - intuitive API\n- \u2705 - accurately tested\n\n\nIf 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.\n\nFor some practical examples on how to use Sequentium, take al look [_here_](https://github.com/VascoSch92/sequentium/examples).\n\n## Quick start\n\nTo install Sequentium, use the following command:\n```shell\npip install sequentium\n```\nSuppose you want to work with the Fibonacci sequence. First, import it into your script:\n```python\nfrom sequence import FibonacciSequence\n\nfibonacci = FibonacciSequence()\n```\nNow, FibonacciSequence is a class representing the Fibonacci sequence. It behaves similarly to a list. \nYou can iterate through it:\n\n```python\nfor x in fibonacci:\n print(x)\n>> 0, 1, 1, 2, 3, 5, 8, 13, 21,...\n```\nOr you can access a specific term directly:\n```python\nfibonacci[8]\n>> 21\n```\nSlicing is also supported:\n```python\nfibonacci[2:8]\n>> [1, 2, 3, 5, 13]\n```\nAdditionally, you can check if a number appears in the `Fibonacci sequence`:\n```python\n7 in fibonacci\n>> False\n21 in fibonacci\n>> True\n```\n## Command Line Interface (CLI)\nSequentium provides a Command Line Interface (CLI) for convenient usage from your terminal.\n```text\nusage: Sequentium [-h] [-v] [--list {integer,generalised} [{integer,generalised} ...]] [-a AT] [-l] [--start START] [--stop STOP] [--step STEP] [-c CONTAINS] [sequence]\n\nSequentium is a user-friendly package that implements various well-known sequences, providing a seamless and intuitive experience for the user\n\npositional arguments:\n sequence Specify the name or identifier of the sequence to operate on.\n\noptions:\n -h, --help show this help message and exit\n -v, --version Display the version information.\n --list {integer,generalised} [{integer,generalised} ...]\n List of implemented sequences.\n\nsequence options:\n -a AT, --at AT Retrieve the term at the specified index in the sequence.\n -l, --length Display the length of the sequence.\n --start START Define the starting point of the sequence.\n --stop STOP End point of the sequence (excluded).\n --step STEP Step size for iterating through the sequence.\n -c CONTAINS, --contains CONTAINS\n Check if the sequence contains a specific value.\n\nFor help with a specific command, see: `sequence help <command>`\n\n```\nHere are some examples illustrating the usage of the Sequentium CLI:\n- specify the index to get a specific element of `FibonacciSequence`\n```text\nsequence FibonacciSequence --at 8\n>> 21\n```\n- define a range of `FibonacciSequence` using start and stop parameters\n\n```text\nsequence FibonacciSequence --start 2 --stop 8\n>> [1, 2, 3, 5, 8, 13]\n```\n- check if a particular number belongs to the `FibonacciSequence`\n```text\nsequence FibonacciSequence --contains 7\n>> False\nsequence FibonacciNumbers --contains 21\n>> True\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sequentium is a user-friendly package that implements various well-known sequences, providing a seamless and intuitive experience for the user",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/VascoSch92/sequentium"
},
"split_keywords": [
"math",
" mathematics",
" sequence",
" fibonacci"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f9db123b46541e37b3144efbf68ef245dad3701c35d9d1ed30c3bc3e0ad34abd",
"md5": "acc7b53a614a90653090b7a180505c0e",
"sha256": "a66a3b067b9cfdeaf5823529814e955bdb4984791ecc678b6267b03fc5e27cb9"
},
"downloads": -1,
"filename": "sequentium-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "acc7b53a614a90653090b7a180505c0e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17435,
"upload_time": "2024-03-31T18:35:00",
"upload_time_iso_8601": "2024-03-31T18:35:00.352436Z",
"url": "https://files.pythonhosted.org/packages/f9/db/123b46541e37b3144efbf68ef245dad3701c35d9d1ed30c3bc3e0ad34abd/sequentium-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-31 18:35:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VascoSch92",
"github_project": "sequentium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sequentium"
}
JSON
