Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bytebaker/randomtimestamp
Files for the RandomTimeStamp module
https://github.com/bytebaker/randomtimestamp
datetime python random-time timestamp
Last synced: about 2 months ago
JSON representation
Files for the RandomTimeStamp module
- Host: GitHub
- URL: https://github.com/bytebaker/randomtimestamp
- Owner: ByteBaker
- License: gpl-3.0
- Created: 2018-09-27T12:49:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T17:02:19.000Z (almost 2 years ago)
- Last Synced: 2024-10-05T22:47:24.005Z (3 months ago)
- Topics: datetime, python, random-time, timestamp
- Language: Python
- Homepage: https://pypi.org/project/randomtimestamp/
- Size: 37.1 KB
- Stars: 6
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
      
# randomtimestamp (v2.2)
Random timestamp generator
## Installation
You know it:
```
pip install randomtimestamp
```
## Usage
randomtimestamp can be used from the command line or imported as a python module.
#### Command line usage
To use the script from command line
```
$ randomtimestamp
30-08-1995 17:58:14
```
#### Python Module Usage
In v2.2, the functions **randomtimestamp**, **random_time**, and **random_date** are available.
1. **randomtimestamp()** takes six optional arguments. A call without arguments returns a datetime between **January 1st, 1950, 00:00:00** and **({today}, 23:59:59)**.
**NOTE**: **start/end** are resolved before **start_year/end_year**, therefore **start_year/end_year** have no effect if **start/end** have been provided.
**WARNING [breaking changes]** : Order of arguments to **randomtimestamp** has been changed in v2.1. If you're passing parameters as positionals, be careful before upgrading. The function also returns a *datetime* object rather than a string.
```
randomtimestamp(
start_year: int = 1950,
end_year: int = None,
text: bool = False,
start: datetime.datetime = None,
end: datetime.datetime = None,
pattern: str = "%d-%m-%Y %H:%M:%S"
) -> Union[datetime, str]:
```
2. **random_time()** takes four optional arguments. A call without arguments returns a time between **between (00:00:00)** and **(23:59:59)**.
```
random_time(
start: datetime.time = time.min,
end: datetime.time = time.max,
text: bool = False,
pattern: str = "%H:%M:%S"
) -> Union[time, str]:
```
3. **random_date()** takes four optional arguments. A call without arguments returns a date between **(January 1, 1950)** and **today**.
```
random_date(
start: datetime.date = date(1950, 1, 1),
end: datetime.date = datetime.today().date(),
text: bool = False,
pattern: str = "%d-%m-%Y"
) -> Union[date, str]:
```
In any of these function calls, **start < end** & **start_year < end_year** is mandatory. **pattern** has no effect if **text = False**.
---
## Changelog:
##### v2.2
- Fixed microsecond handling bug in datetime range. Closes [issue](https://github.com/ByteBaker/ubuntu21-btfix/issues/1).
##### v2.1
- Dropped a minor version identifier to account for the small size of module. Only 2 digits to be used hereafter.
- [Breaking change] Order of arguments to randomtimestamp() changed. Code using older versions without keyword arguments breaks.
- [Breaking change] By default **randomtimestamp()** now generates datetime objects. **text = False** by default.
- Introduced **random_time() & random_date()** to generate only time or date if needed.
##### v2.0.0
- Ability to provide **start/end** as datetime objects to randomtimestamp() for more precise control.
- Lower limit of **start_year = 1950** removed.
- Ability to use custom datetime pattern as described in [datetime documentation](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes).
##### v1.0.0
- Randomtimestamp released. Timestamps can be generated between 1950 and current_year.
- The timestamp can be generated as a string (by default) or a datetime object.
---
## Examples:
Here are some examples of the possible syntaxes:
```
>>> from randomtimestamp import randomtimestamp, random_date, random_time
>>> randomtimestamp()
datetime.datetime(1970, 6, 2, 23, 34, 10)
>>> randomtimestamp(start_year=2020, end_year=2021)
datetime.datetime(2021, 1, 10, 5, 6, 19)
>>> randomtimestamp(start_year=2020, end_year=2021, text=True)
'05-09-2021 17:24:28'
>>> random_time()
datetime.time(13, 18, 14)
>>> random_date()
datetime.date(1990, 6, 13)
>>> random_time(text=True, pattern='%I:%M:%S %p')
'08:06:27 PM'
```
In any case, if you ever feel stuck, use **help(randomtimestamp)** inside Python's REPL.
---
#### Footnote:
Type validation has been done, but it won't be required for most developers. If you're someone who likes to break the code with deliberately crafted inputs, you'd most likely receive a **TypeError** or a **ValueError**.
However, if you do find a bug, please report to make the experience better for other developers.
## License
This project is released under [GNU GENERAL PUBLIC LICENSE V3](https://www.gnu.org/licenses/gpl-3.0.en.html).