| Name | primegenerators JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | |
| Summary | A library of prime number generators and analyzers, that also has a command-line interface |
| upload_time | 2023-11-03 05:00:29 |
| maintainer | |
| docs_url | None |
| author | big-jr |
| requires_python | >=3.10,<4.0 |
| license | Apache-2.0 |
| keywords |
prime
numbers
generator
cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PrimeGenerators - Prime Number Generation and Utilities
## Command Line Interface
The prime generator can be run from the command line. The output can be piped or redirected to a separate file or
process.
```bash
usage: primegenerators [-h] [-c COUNT] [-f {text,json}]
Random number generator and analyzer.
options:
-h, --help show this help message and exit
-c COUNT, --count COUNT
The number of values to generate
-f {text,json}, --format {text,json}
The format of the output
```
## Python Library
The prime generator should be created using the factory method, e.g.:
```python
from primegenerators import get_generator
# Details elided
generator = get_generator("eratosthenes")
for index, prime in enumerate(generator.primes()):
sys.stdout.write(str(prime))
# Further processing and exit conditions
```
### Member Functions
```python
primes() -> Iterator[int]
```
Generate an endless series of prime numbers, starting with 2.
Returns an iterator over the series of prime numbers.
```python
primes_range(minimum: int, maximum: int) -> Iterator[int]
```
Return an iterator over the series of prime numbers between minimum
and maximum inclusive.
**minimum:** The minimum number in the series. If this number is not prime,
the first number in the series is the first prime higher than this number.
**maximum:** The maximum number in the series. If this number is not prime,
the last number in the series is the last prime lower than this number.
```python
is_prime(number: int) -> bool
```
Determine whether a given number is prime or not.
**number:** The number to be checked for prime-ness
Returns `True` if the candidate number is prime, otherwise `False`
```python
prime_factors(self, number: int) -> Counter
```
Calculate the prime factors of a number.
**number:** The number to be factorized
Returns a `collections.Counter` object containing the prime factors of `number`
## Download Statistics
[](https://pepy.tech/project/primegenerators)
[](https://pepy.tech/project/primegenerators)
[](https://pepy.tech/project/primegenerators)
Raw data
{
"_id": null,
"home_page": "",
"name": "primegenerators",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "prime,numbers,generator,cli",
"author": "big-jr",
"author_email": "githubcomms@softwarepragmatism.com",
"download_url": "https://files.pythonhosted.org/packages/e1/02/2b040bb28ae65b716f107b7c093adfdbf41ec12735b3820e8c0da55cd768/primegenerators-0.0.5.tar.gz",
"platform": null,
"description": "# PrimeGenerators - Prime Number Generation and Utilities\n\n## Command Line Interface\n\nThe prime generator can be run from the command line. The output can be piped or redirected to a separate file or\nprocess.\n\n```bash\nusage: primegenerators [-h] [-c COUNT] [-f {text,json}]\n\nRandom number generator and analyzer.\n\noptions:\n -h, --help show this help message and exit\n -c COUNT, --count COUNT\n The number of values to generate\n -f {text,json}, --format {text,json}\n The format of the output\n```\n\n## Python Library\n\nThe prime generator should be created using the factory method, e.g.:\n\n```python\nfrom primegenerators import get_generator\n\n# Details elided\n\ngenerator = get_generator(\"eratosthenes\")\n\nfor index, prime in enumerate(generator.primes()):\n sys.stdout.write(str(prime))\n\n # Further processing and exit conditions\n```\n\n### Member Functions\n\n```python\nprimes() -> Iterator[int]\n```\n\nGenerate an endless series of prime numbers, starting with 2.\n\nReturns an iterator over the series of prime numbers.\n\n```python\nprimes_range(minimum: int, maximum: int) -> Iterator[int]\n```\n\nReturn an iterator over the series of prime numbers between minimum\nand maximum inclusive.\n\n**minimum:** The minimum number in the series. If this number is not prime,\nthe first number in the series is the first prime higher than this number.\n\n**maximum:** The maximum number in the series. If this number is not prime,\nthe last number in the series is the last prime lower than this number.\n\n```python\nis_prime(number: int) -> bool\n```\n\nDetermine whether a given number is prime or not.\n\n**number:** The number to be checked for prime-ness\n\nReturns `True` if the candidate number is prime, otherwise `False`\n\n```python\nprime_factors(self, number: int) -> Counter\n```\n\nCalculate the prime factors of a number.\n\n**number:** The number to be factorized\n\nReturns a `collections.Counter` object containing the prime factors of `number`\n\n## Download Statistics\n\n[](https://pepy.tech/project/primegenerators)\n[](https://pepy.tech/project/primegenerators)\n[](https://pepy.tech/project/primegenerators)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A library of prime number generators and analyzers, that also has a command-line interface",
"version": "0.0.5",
"project_urls": null,
"split_keywords": [
"prime",
"numbers",
"generator",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3fea3973b1d7321955ca1e19a2785f389bd61effa296caa37669ef8caa8fa536",
"md5": "bea76972fdbe47020b5f24d539746be1",
"sha256": "d2d48717ce0227bf00a5fff5b8327bcb0c9af66653c4d1bf3651b1b14b0d7b6b"
},
"downloads": -1,
"filename": "primegenerators-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bea76972fdbe47020b5f24d539746be1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 6408,
"upload_time": "2023-11-03T05:00:27",
"upload_time_iso_8601": "2023-11-03T05:00:27.824397Z",
"url": "https://files.pythonhosted.org/packages/3f/ea/3973b1d7321955ca1e19a2785f389bd61effa296caa37669ef8caa8fa536/primegenerators-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1022b040bb28ae65b716f107b7c093adfdbf41ec12735b3820e8c0da55cd768",
"md5": "33ab554d394f4b61edd06e071d4fbf43",
"sha256": "36e708da5258a65df2823e38df223bc135ebeee133bc09e02f41bc31038b816c"
},
"downloads": -1,
"filename": "primegenerators-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "33ab554d394f4b61edd06e071d4fbf43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 9256,
"upload_time": "2023-11-03T05:00:29",
"upload_time_iso_8601": "2023-11-03T05:00:29.540402Z",
"url": "https://files.pythonhosted.org/packages/e1/02/2b040bb28ae65b716f107b7c093adfdbf41ec12735b3820e8c0da55cd768/primegenerators-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 05:00:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "primegenerators"
}
