| Name | nerdyversary JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | Package for computing nerdy anniversaries |
| upload_time | 2023-01-04 14:56:58 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
maths
anniversary
nerdy
irrational-numbers
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Nerdyversary
[](https://github.com/rmnldwg/nerdyversary/blob/main/LICENSE)
[](https://github.com/rmnldwg/nerdyversary)
[](https://pypi.org/project/nerdyversary/)
[](https://rmnldwg.github.io/nerdyversary/)
[](https://rmnldwg.github.io/nerdyversary/)
Small project about finding "nerdy anniversaries". An obvious example would be that after 3.1415... years one could celebrate the $\pi$-th anniversary. The code in this repo finds nice combinations of numbers like $\pi$, $e$, $\phi$ and so on and can construct fractions for the approximation.
## Installation
### From PyPI
Simply use
```
$ pip install nerdyversary
```
to install this package in your environment.
### From Source
To install `nerdyversary` from source, follow these steps below:
1. Clone the repository
```
$ git clone https://github.com/rmnldwg/nerdyversary
```
1. Create a Virtual Environment (optional, but recommended)
```
$ python3 -m venv .venv
```
You should do this with an installation of Python 3.10 or later. And don't forget to activate the environment with
```
$ source .venv/bin/activate
```
1. Use `pip` to install
```
$ pip install -U pip setuptools setuptools-scm
$ pip install .
```
## Usage
### Script
```
usage: nerdyversary [-h] [-v] [-d SPECIAL_DAY] [-s START] [-e END]
[--max-power MAX_POWER] [--factor-lim FACTOR_LIM]
[--format FORMAT]
Find beautiful nerdyversaries.
options:
-h, --help show this help message and exit
-v, --version Show the installed version and exit.
-d SPECIAL_DAY, --special-day SPECIAL_DAY
Date of the special day in ISO format. (default: 2023-01-04)
-s START, --start START
Date when to start with search in ISO format. (default:
2023-01-04)
-e END, --end END Date when to end the search in ISO format. (default:
2024-01-04)
--max-power MAX_POWER
Largest exponent to consider for building the nerdyversaries.
(default: 5)
--factor-lim FACTOR_LIM
Largest multiple of a symbol that is accepted. (default: 10)
--format FORMAT The output format that will be used by the `tabulate` package.
(default: simple)
```
The `FORMAT` argument must be one of the strings the [tabulate](https://github.com/astanin/python-tabulate#table-format) package understands.
An example: The input
```
$ nerdyversary -d 2012-12-21 -s 2023-01-01 -e 2024-01-01 --format pipe --factor-lim 4 --max-power 3
```
will yield a markdown table that renders into the following:
| Date | Days | Years | Expression |
|:-------------|-------:|--------:|:-------------------------------|
| 6. Jan 2023 | 3668 | 10.04 | $\frac{e^{3}}{2}$ |
| 24. Feb 2023 | 3717 | 10.18 | $\frac{5 e^{3}}{\pi^{2}}$ |
| 12. Jun 2023 | 3825 | 10.47 | $4 \phi^{2}$ |
| 19. Jun 2023 | 3832 | 10.49 | $\frac{5 \pi^{3}}{2 e^{2}}$ |
| 25. Jul 2023 | 3868 | 10.59 | $\frac{5 \phi^{3}}{2}$ |
| 5. Nov 2023 | 3971 | 10.87 | $4 e$ |
| 12. Nov 2023 | 3978 | 10.89 | $\frac{3 \pi^{2}}{e}$ |
| 14. Dec 2023 | 4010 | 10.98 | $\frac{3 \pi^{3}}{2 \phi^{3}}$ |
The symbols here are
* the golden ratio $\phi \approx 1.618\ldots$
* the number $\pi \approx 3.1415\ldots$
* Euler's number $e \approx 2.718\ldots$
When using this package as a library, arbitrary constants may be defined as symbols.
### Library API
The API documentation is hosted [here](https://rmnldwg.github.io/nerdyversary).
Raw data
{
"_id": null,
"home_page": "",
"name": "nerdyversary",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "maths,anniversary,nerdy,irrational-numbers",
"author": "",
"author_email": "Roman Ludwig <roman.ludwig@usz.ch>",
"download_url": "https://files.pythonhosted.org/packages/ef/98/a5935db547aa79fe06ee9f8ba9ee2ccab13b9bda215987aadd2cde711635/nerdyversary-0.1.1.tar.gz",
"platform": null,
"description": "\n\n# Nerdyversary\n\n[](https://github.com/rmnldwg/nerdyversary/blob/main/LICENSE)\n[](https://github.com/rmnldwg/nerdyversary)\n[](https://pypi.org/project/nerdyversary/)\n[](https://rmnldwg.github.io/nerdyversary/)\n[](https://rmnldwg.github.io/nerdyversary/)\n\nSmall project about finding \"nerdy anniversaries\". An obvious example would be that after 3.1415... years one could celebrate the $\\pi$-th anniversary. The code in this repo finds nice combinations of numbers like $\\pi$, $e$, $\\phi$ and so on and can construct fractions for the approximation.\n\n\n## Installation\n\n### From PyPI\n\nSimply use\n```\n$ pip install nerdyversary\n```\nto install this package in your environment.\n\n\n### From Source\n\nTo install `nerdyversary` from source, follow these steps below:\n\n1. Clone the repository\n ```\n $ git clone https://github.com/rmnldwg/nerdyversary\n ```\n\n1. Create a Virtual Environment (optional, but recommended)\n ```\n $ python3 -m venv .venv\n ```\n You should do this with an installation of Python 3.10 or later. And don't forget to activate the environment with\n ```\n $ source .venv/bin/activate\n ```\n\n1. Use `pip` to install\n ```\n $ pip install -U pip setuptools setuptools-scm\n $ pip install .\n ```\n\n\n## Usage\n\n### Script\n\n```\nusage: nerdyversary [-h] [-v] [-d SPECIAL_DAY] [-s START] [-e END]\n [--max-power MAX_POWER] [--factor-lim FACTOR_LIM]\n [--format FORMAT]\n\nFind beautiful nerdyversaries.\n\noptions:\n -h, --help show this help message and exit\n -v, --version Show the installed version and exit.\n -d SPECIAL_DAY, --special-day SPECIAL_DAY\n Date of the special day in ISO format. (default: 2023-01-04)\n -s START, --start START\n Date when to start with search in ISO format. (default:\n 2023-01-04)\n -e END, --end END Date when to end the search in ISO format. (default:\n 2024-01-04)\n --max-power MAX_POWER\n Largest exponent to consider for building the nerdyversaries.\n (default: 5)\n --factor-lim FACTOR_LIM\n Largest multiple of a symbol that is accepted. (default: 10)\n --format FORMAT The output format that will be used by the `tabulate` package.\n (default: simple)\n```\n\nThe `FORMAT` argument must be one of the strings the [tabulate](https://github.com/astanin/python-tabulate#table-format) package understands.\n\nAn example: The input\n```\n$ nerdyversary -d 2012-12-21 -s 2023-01-01 -e 2024-01-01 --format pipe --factor-lim 4 --max-power 3\n```\nwill yield a markdown table that renders into the following:\n\n| Date | Days | Years | Expression |\n|:-------------|-------:|--------:|:-------------------------------|\n| 6. Jan 2023 | 3668 | 10.04 | $\\frac{e^{3}}{2}$ |\n| 24. Feb 2023 | 3717 | 10.18 | $\\frac{5 e^{3}}{\\pi^{2}}$ |\n| 12. Jun 2023 | 3825 | 10.47 | $4 \\phi^{2}$ |\n| 19. Jun 2023 | 3832 | 10.49 | $\\frac{5 \\pi^{3}}{2 e^{2}}$ |\n| 25. Jul 2023 | 3868 | 10.59 | $\\frac{5 \\phi^{3}}{2}$ |\n| 5. Nov 2023 | 3971 | 10.87 | $4 e$ |\n| 12. Nov 2023 | 3978 | 10.89 | $\\frac{3 \\pi^{2}}{e}$ |\n| 14. Dec 2023 | 4010 | 10.98 | $\\frac{3 \\pi^{3}}{2 \\phi^{3}}$ |\n\nThe symbols here are\n\n* the golden ratio $\\phi \\approx 1.618\\ldots$\n* the number $\\pi \\approx 3.1415\\ldots$\n* Euler's number $e \\approx 2.718\\ldots$\n\nWhen using this package as a library, arbitrary constants may be defined as symbols.\n\n\n### Library API\n\nThe API documentation is hosted [here](https://rmnldwg.github.io/nerdyversary).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package for computing nerdy anniversaries",
"version": "0.1.1",
"split_keywords": [
"maths",
"anniversary",
"nerdy",
"irrational-numbers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d06c37aaed2ca1cde25a99dc68fa244d4f824df2f468c1646d40e5d494d34117",
"md5": "db8664799e59d134f62bf23829e17615",
"sha256": "6e312787be55a2b807bfd3cb6a8ae490bf473e267fd0efd8a178b3a603f9b030"
},
"downloads": -1,
"filename": "nerdyversary-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db8664799e59d134f62bf23829e17615",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7197,
"upload_time": "2023-01-04T14:56:57",
"upload_time_iso_8601": "2023-01-04T14:56:57.146416Z",
"url": "https://files.pythonhosted.org/packages/d0/6c/37aaed2ca1cde25a99dc68fa244d4f824df2f468c1646d40e5d494d34117/nerdyversary-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef98a5935db547aa79fe06ee9f8ba9ee2ccab13b9bda215987aadd2cde711635",
"md5": "84cebfa7c275556903e2e160451ab255",
"sha256": "12f68f6d264cd03d8890e01fcddc2eba014523af94f989a0634f21f4b7153702"
},
"downloads": -1,
"filename": "nerdyversary-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "84cebfa7c275556903e2e160451ab255",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 292201,
"upload_time": "2023-01-04T14:56:58",
"upload_time_iso_8601": "2023-01-04T14:56:58.459756Z",
"url": "https://files.pythonhosted.org/packages/ef/98/a5935db547aa79fe06ee9f8ba9ee2ccab13b9bda215987aadd2cde711635/nerdyversary-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-04 14:56:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "nerdyversary"
}
