Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonw/datasette-render-timestamps
Datasette plugin for rendering timestamps
https://github.com/simonw/datasette-render-timestamps
datasette datasette-io datasette-plugin
Last synced: 3 months ago
JSON representation
Datasette plugin for rendering timestamps
- Host: GitHub
- URL: https://github.com/simonw/datasette-render-timestamps
- Owner: simonw
- License: apache-2.0
- Created: 2019-10-10T22:50:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-01T04:58:29.000Z (almost 2 years ago)
- Last Synced: 2024-10-06T20:31:11.610Z (3 months ago)
- Topics: datasette, datasette-io, datasette-plugin
- Language: Python
- Size: 16.6 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# datasette-render-timestamps
[](https://pypi.org/project/datasette-render-timestamps/)
[](https://circleci.com/gh/simonw/datasette-render-timestamps)
[](https://github.com/simonw/datasette-render-timestamps/blob/master/LICENSE)
Datasette plugin for rendering timestamps.
## Installation
Install this plugin in the same environment as Datasette to enable this new functionality:
pip install datasette-render-timestamps
The plugin will then look out for integer numbers that are likely to be timestamps - anything that would be a number of seconds from 5 years ago to 5 years in the future.
These will then be rendered in a more readable format.
## Configuration
You can disable automatic column detection in favour of explicitly listing the columns that you would like to render using [plugin configuration](https://datasette.readthedocs.io/en/stable/plugins.html#plugin-configuration) in a `metadata.json` file.
Add a `"datasette-render-timestamps"` configuration block and use a `"columns"` key to list the columns you would like to treat as timestamp values:
```json
{
"plugins": {
"datasette-render-timestamps": {
"columns": ["created", "updated"]
}
}
}
```
This will cause any `created` or `updated` columns in any table to be treated as timestamps and rendered.
Save this to `metadata.json` and run datasette with the `--metadata` flag to load this configuration:
datasette serve mydata.db --metadata metadata.json
To disable automatic timestamp detection entirely, you can use `"columnns": []`.
This configuration block can be used at the top level, or it can be applied just to specific databases or tables. Here's how to apply it to just the `entries` table in the `news.db` database:
```json
{
"databases": {
"news": {
"tables": {
"entries": {
"plugins": {
"datasette-render-timestamps": {
"columns": ["created", "updated"]
}
}
}
}
}
}
}
```
And here's how to apply it to every `created` column in every table in the `news.db` database:
```json
{
"databases": {
"news": {
"plugins": {
"datasette-render-timestamps": {
"columns": ["created", "updated"]
}
}
}
}
}
```
### Customizing the date format
The default format is `%B %d, %Y - %H:%M:%S UTC` which renders for example: `October 10, 2019 - 07:18:29 UTC`. If you want another format, the date format can be customized using plugin configuration. Any format string supported by [strftime](http://strftime.org/) may be used. For example:
```json
{
"plugins": {
"datasette-render-timestamps": {
"format": "%Y-%m-%d-%H:%M:%S"
}
}
}
```