# eouTools
## Requirements
- python >= 3.10 (Required)
- python >= 3.12 (Suggested)
- numpy (Suggested)
- Deprecated (Required)
## eouTools.numbers
### isPositive
Syntax: isPositive(n: int | float) -> bool<br>
Alternative: `not isNegative(n)`<br>
Documentation: "Returns whether `n` is positive or not"
### isNegative
Syntax: `isNegative(n: int | float) -> bool`<br>
Alternative: `not isPositive(n)`<br>
Documentation: "Returns whether `n` is negative or not"
### isZero
Syntax: `isZero(n: int | float) -> bool`<br>
Alternative: `n == 0`<br>
Documentation: "Returns whether `n` is zero or not"
## eouTools.decorators
### rename_on_init
Syntax: `@rename_on_init(name: str)`<br>
Documentation: "Rename a function when it is initialized. This may raise unexpected behavior, however"
### retry
Syntax: `@retry(amount: Optional[int], stop_at: Optional[Tuple[Exception]])`<br>
Documentation: "Try calling the functon `amount` amount of times, but stop if the exception raised is in `stop_at` or if the function did not raise an error"
### cache
Syntax: `@cache`<br>
Documentation: "Create a cache of all results given by a function. run the `.clear_cache()` function to delete the cache. Can be used to speed up certain algorithms such as recursive Fibonacci sequence"
## eouTools.benchmarking.decorators
### time_func
Syntax: `@time_func`<br>
Documentation: "Time a function. Parse in the keyworded argument `_no_time = True` to get the return instead of the time it took to execute"
## eouTools.arithmetic_equations.integers
### factorial
Syntax: `factorial(n: int) -> int`<br>
Documentation: "Calculate the factorial of a number"<br>
Requirements: `numpy`
## eouTools.arithmetic_equations.integrals
### integrate
Syntax: `integrate(func: Callable, start: Optional[int | float], end: Optional[int | float], dx: Optional[int | float]) -> float`<br>
Documentation: [Self-Explanatory]<br>
Used Builtins: `multiprocessing`
### fib
Syntax: `fib(n: int) -> int`<br>
Documentation: `Calculate the fibonacci sequence for a number recursively`<br>
Requirements:
- numpy (suggested)
## eouTools.rng.random
### seed
Syntax: `seed(a: Optional[int | float | bytes | bytearray)`
Documentation: `To be used as a context manager`
Requirements:
- numpy (suggested)
### aseed
Syntax: `aseed(a: Optional[int | float | bytes | bytearray)`
Documentation: `To be used as an asynchronous context manager`
###### _69 lines, nice!_
Requirements:
- numpy (suggested)
## eouTools.constants
### Constant
Syntax: `Constant(value: Any)`
Documentation: `A constant, read-only value.`
## Commandline
### Commands
- `-V`: Show the installation version
- `--install-requirements`: Install all requirements
- `--upgrade`: Update to the newest version of eouTools
### Usage
```commandline
python -m eouTools <command>
```
# eouTools Installation Guide
## 1 - Requirements
Make sure you meet the following requirements:
- python >= 3.10 (required)
- python >= 3.12 (suggested)
- pip >= 20.3.1 (suggested?)
- numpy<=1.26.4 (suggested?)
- numpy (suggested)
- Deprecated (required)
## 2 - Requirements Installation
How to install certain requirements if your system does not already meet them
### pip >= 20.3.1
```commandline
python -m pip install --upgrade pip>=20.3.1
```
### numpy<=1.26.4
```commandline
python -m pip install --upgrade numpy<=1.26.4
```
### numpy
```commandline
python -m pip install --upgrade numpy
```
## Deprecated
```commandline
python -m pip install --upgrade Deprecated
```
## 3 - Installation
To install eouTools, please run:
```commandline
python -m pip install eouTools
```
## 4 - Updates
If you wish to upgrade to the latest version of eouTools when new releases come out, run:
```commandline
python -m pip install --upgrade eouTools
```
## 5 - Removal
If you wish to uninstall eouTools, run:
```commandline
python -m pip uninstall eouTools
```
And please leave us a feedback with what drove you to uninstall it
Raw data
{
"_id": null,
"home_page": "https://github.com/cornusandu/eouTools",
"name": "eouTools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Sandu Bogdan",
"author_email": "bogdanelsandu@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/76/dd/f82d567164fc14908c3cdf76ad20a9bd1ffc7cf4e536d80758bc05fab44d/eoutools-0.1.0.tar.gz",
"platform": null,
"description": "# eouTools\r\n## Requirements\r\n- python >= 3.10 (Required)\r\n- python >= 3.12 (Suggested)\r\n- numpy (Suggested)\r\n- Deprecated (Required)\r\n## eouTools.numbers\r\n### isPositive\r\nSyntax: isPositive(n: int | float) -> bool<br>\r\nAlternative: `not isNegative(n)`<br>\r\nDocumentation: \"Returns whether `n` is positive or not\"\r\n\r\n### isNegative\r\nSyntax: `isNegative(n: int | float) -> bool`<br>\r\nAlternative: `not isPositive(n)`<br>\r\nDocumentation: \"Returns whether `n` is negative or not\"\r\n\r\n### isZero\r\nSyntax: `isZero(n: int | float) -> bool`<br>\r\nAlternative: `n == 0`<br>\r\nDocumentation: \"Returns whether `n` is zero or not\"\r\n\r\n## eouTools.decorators\r\n### rename_on_init\r\nSyntax: `@rename_on_init(name: str)`<br>\r\nDocumentation: \"Rename a function when it is initialized. This may raise unexpected behavior, however\"\r\n\r\n### retry\r\nSyntax: `@retry(amount: Optional[int], stop_at: Optional[Tuple[Exception]])`<br>\r\nDocumentation: \"Try calling the functon `amount` amount of times, but stop if the exception raised is in `stop_at` or if the function did not raise an error\"\r\n\r\n### cache\r\nSyntax: `@cache`<br>\r\nDocumentation: \"Create a cache of all results given by a function. run the `.clear_cache()` function to delete the cache. Can be used to speed up certain algorithms such as recursive Fibonacci sequence\"\r\n\r\n## eouTools.benchmarking.decorators\r\n### time_func\r\nSyntax: `@time_func`<br>\r\nDocumentation: \"Time a function. Parse in the keyworded argument `_no_time = True` to get the return instead of the time it took to execute\"\r\n\r\n## eouTools.arithmetic_equations.integers\r\n### factorial\r\nSyntax: `factorial(n: int) -> int`<br>\r\nDocumentation: \"Calculate the factorial of a number\"<br>\r\nRequirements: `numpy`\r\n\r\n## eouTools.arithmetic_equations.integrals\r\n### integrate\r\nSyntax: `integrate(func: Callable, start: Optional[int | float], end: Optional[int | float], dx: Optional[int | float]) -> float`<br>\r\nDocumentation: [Self-Explanatory]<br>\r\nUsed Builtins: `multiprocessing`\r\n\r\n### fib\r\nSyntax: `fib(n: int) -> int`<br>\r\nDocumentation: `Calculate the fibonacci sequence for a number recursively`<br>\r\nRequirements:\r\n- numpy (suggested)\r\n\r\n## eouTools.rng.random\r\n### seed\r\nSyntax: `seed(a: Optional[int | float | bytes | bytearray)`\r\nDocumentation: `To be used as a context manager`\r\nRequirements:\r\n- numpy (suggested)\r\n\r\n### aseed\r\nSyntax: `aseed(a: Optional[int | float | bytes | bytearray)`\r\nDocumentation: `To be used as an asynchronous context manager`\r\n###### _69 lines, nice!_\r\nRequirements:\r\n- numpy (suggested)\r\n\r\n## eouTools.constants\r\n### Constant\r\nSyntax: `Constant(value: Any)`\r\nDocumentation: `A constant, read-only value.`\r\n\r\n## Commandline\r\n### Commands\r\n- `-V`: Show the installation version\r\n- `--install-requirements`: Install all requirements\r\n- `--upgrade`: Update to the newest version of eouTools\r\n\r\n### Usage\r\n```commandline\r\npython -m eouTools <command>\r\n```\r\n# eouTools Installation Guide\r\n## 1 - Requirements\r\nMake sure you meet the following requirements:\r\n- python >= 3.10 (required)\r\n- python >= 3.12 (suggested)\r\n- pip >= 20.3.1 (suggested?)\r\n- numpy<=1.26.4 (suggested?)\r\n- numpy (suggested)\r\n- Deprecated (required)\r\n\r\n## 2 - Requirements Installation\r\nHow to install certain requirements if your system does not already meet them\r\n### pip >= 20.3.1\r\n```commandline\r\npython -m pip install --upgrade pip>=20.3.1\r\n```\r\n\r\n### numpy<=1.26.4\r\n```commandline\r\npython -m pip install --upgrade numpy<=1.26.4\r\n```\r\n\r\n### numpy\r\n```commandline\r\npython -m pip install --upgrade numpy\r\n```\r\n\r\n## Deprecated\r\n```commandline\r\npython -m pip install --upgrade Deprecated\r\n```\r\n\r\n## 3 - Installation\r\nTo install eouTools, please run:\r\n```commandline\r\npython -m pip install eouTools\r\n```\r\n\r\n## 4 - Updates\r\nIf you wish to upgrade to the latest version of eouTools when new releases come out, run:\r\n```commandline\r\npython -m pip install --upgrade eouTools\r\n```\r\n\r\n## 5 - Removal\r\nIf you wish to uninstall eouTools, run:\r\n```commandline\r\npython -m pip uninstall eouTools\r\n```\r\nAnd please leave us a feedback with what drove you to uninstall it\r\n",
"bugtrack_url": null,
"license": null,
"summary": "eouTools adds new ease-of-use features to python!",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/cornusandu/eouTools/issues",
"GitHub Repository": "https://github.com/cornusandu/eouTools",
"Homepage": "https://github.com/cornusandu/eouTools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afb15a975fa01e529352299c8234182630225f0e3eb413888681836f47d5cbf8",
"md5": "95b1af8195c7962f0700b9ecf3364805",
"sha256": "a2a2f44db7501229fad6f105a25a8d1ff72023cd0615047a950611bfe23c7547"
},
"downloads": -1,
"filename": "eouTools-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95b1af8195c7962f0700b9ecf3364805",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8710,
"upload_time": "2024-09-03T08:50:57",
"upload_time_iso_8601": "2024-09-03T08:50:57.042494Z",
"url": "https://files.pythonhosted.org/packages/af/b1/5a975fa01e529352299c8234182630225f0e3eb413888681836f47d5cbf8/eouTools-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76ddf82d567164fc14908c3cdf76ad20a9bd1ffc7cf4e536d80758bc05fab44d",
"md5": "1169b8008fe723add10f92dd0502b73f",
"sha256": "6c6e3dbaed07e41674902a3f0bd5b80daa7e87dcad61b42f4e40953139aba26a"
},
"downloads": -1,
"filename": "eoutools-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1169b8008fe723add10f92dd0502b73f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7811,
"upload_time": "2024-09-03T08:50:58",
"upload_time_iso_8601": "2024-09-03T08:50:58.028230Z",
"url": "https://files.pythonhosted.org/packages/76/dd/f82d567164fc14908c3cdf76ad20a9bd1ffc7cf4e536d80758bc05fab44d/eoutools-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-03 08:50:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cornusandu",
"github_project": "eouTools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "eoutools"
}
JSON
