[release-image]: https://img.shields.io/github/v/release/karjanme/wx-twitter-bot
[release-url]: https://ghcr.io/karjanme/wx-twitter-bot
[![Release][release-image]][release-url]
# Wx Twitter Bot
A bot that tweets about the weather.
## Capabilities
- Solar Times (sunrise, noon, sunset)
- Lunar Times (moonrise, illumination, moonset)
- Air Quality
## Quick Start
In order to use this application with Twitter, developer credentials are required. Get them [here](https://developer.twitter.com/).
### Command Line
To run this application via the command line, execute the following from the project root directory:
```
python src/main.py [options]
```
Options:
| Name | Description |
| ---- | ----------- |
| `--app-root` | Path to the application root directory which contains the `.env` file. |
### Docker
This application can be run in a docker container using a published image.
For example:
```
docker pull ghcr.io/karjanme/wx-twitter-bot:latest
```
Configure the `TZ` environment variable when setting up the container.
Required volume mapping:
| Volume | Description |
| ------ | ----------- |
| `/app` | Must point to a directory on your host which contains the `.env` file. <br /> The appliation will create subdirectories to facilitate runtime needs. |
## Environment Variables
The following variables can be set using a `.env` file placed in the application root directory.
| Name | Description |
| ---- | ----------- |
| `LOG_LEVEL` | (optional) Specifies the [level](https://docs.python.org/3/library/logging.html#levels) of logging to use when executing the application (Default = "INFO") |
| `LOCATION` | A label for the location associated the this instance of the application |
| `REGION` | A label for the location's region associated with this instance of the application |
| `TIMEZONE` | The timezone name for the location associated with this instance of the application from the "tz database" |
| `LATITUDE` | The latitude for the location associated with this application, decimal format |
| `LONGITUDE` | The longitude for the location associated with this application, decimal format |
| `AIR_NOW_API_KEY` | The key for the [AirNow API](https://docs.airnowapi.org/) |
| `TWITTER_CONSUMER_KEY` | The consumer key for the Twitter API |
| `TWITTER_CONSUMER_SECRET` | The consumer secret for the Twitter API |
| `TWITTER_ACCESS_TOKEN` | The access token for the Twitter API |
| `TWITTER_ACCESS_TOKEN_SECRET` | The access token secret for the Twitter API |
| `TWITTER_BEARER_TOKEN` | The bearer token for the Twitter API |
| `TWITTER_HASHTAG` | (optional) Text to be appended to all tweets as a [hashtag](https://help.twitter.com/en/using-twitter/how-to-use-hashtags) |
## License
[MIT License](https://github.com/jnsnkrllive/wx-twitter-bot/blob/master/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/karjanme/wx-twitter-bot",
"name": "wxtwitterbot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Karl Jansen",
"author_email": "jnsnkrl@live.com",
"download_url": "",
"platform": null,
"description": "[release-image]: https://img.shields.io/github/v/release/karjanme/wx-twitter-bot\n[release-url]: https://ghcr.io/karjanme/wx-twitter-bot\n\n[![Release][release-image]][release-url]\n\n# Wx Twitter Bot\n\nA bot that tweets about the weather.\n\n## Capabilities\n\n- Solar Times (sunrise, noon, sunset)\n- Lunar Times (moonrise, illumination, moonset)\n- Air Quality\n\n## Quick Start\n\nIn order to use this application with Twitter, developer credentials are required. Get them [here](https://developer.twitter.com/).\n\n### Command Line\n\nTo run this application via the command line, execute the following from the project root directory:\n\n```\npython src/main.py [options]\n```\n\nOptions:\n| Name | Description |\n| ---- | ----------- |\n| `--app-root` | Path to the application root directory which contains the `.env` file. |\n\n### Docker\n\nThis application can be run in a docker container using a published image.\n\nFor example:\n```\ndocker pull ghcr.io/karjanme/wx-twitter-bot:latest\n```\n\nConfigure the `TZ` environment variable when setting up the container.\n\nRequired volume mapping:\n| Volume | Description |\n| ------ | ----------- |\n| `/app` | Must point to a directory on your host which contains the `.env` file. <br /> The appliation will create subdirectories to facilitate runtime needs. |\n\n## Environment Variables\n\nThe following variables can be set using a `.env` file placed in the application root directory.\n\n| Name | Description |\n| ---- | ----------- |\n| `LOG_LEVEL` | (optional) Specifies the [level](https://docs.python.org/3/library/logging.html#levels) of logging to use when executing the application (Default = \"INFO\") |\n| `LOCATION` | A label for the location associated the this instance of the application |\n| `REGION` | A label for the location's region associated with this instance of the application |\n| `TIMEZONE` | The timezone name for the location associated with this instance of the application from the \"tz database\" |\n| `LATITUDE` | The latitude for the location associated with this application, decimal format |\n| `LONGITUDE` | The longitude for the location associated with this application, decimal format |\n| `AIR_NOW_API_KEY` | The key for the [AirNow API](https://docs.airnowapi.org/) |\n| `TWITTER_CONSUMER_KEY` | The consumer key for the Twitter API |\n| `TWITTER_CONSUMER_SECRET` | The consumer secret for the Twitter API |\n| `TWITTER_ACCESS_TOKEN` | The access token for the Twitter API |\n| `TWITTER_ACCESS_TOKEN_SECRET` | The access token secret for the Twitter API |\n| `TWITTER_BEARER_TOKEN` | The bearer token for the Twitter API |\n| `TWITTER_HASHTAG` | (optional) Text to be appended to all tweets as a [hashtag](https://help.twitter.com/en/using-twitter/how-to-use-hashtags) |\n\n## License\n\n[MIT License](https://github.com/jnsnkrllive/wx-twitter-bot/blob/master/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wx Twitter Bot",
"version": "1.3.2",
"project_urls": {
"Homepage": "https://github.com/karjanme/wx-twitter-bot"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ed69546995fdb76c5a2b5457480768102869c43cc634a79fa2880933c4b76a6",
"md5": "b4eb81c775554a84f5a73235b8b79617",
"sha256": "f83e1fe20389fc135ebabf7c0395d62ca06355ddeaefafbae265639a44f4007f"
},
"downloads": -1,
"filename": "wxtwitterbot-1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4eb81c775554a84f5a73235b8b79617",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14701,
"upload_time": "2023-10-02T06:00:36",
"upload_time_iso_8601": "2023-10-02T06:00:36.465953Z",
"url": "https://files.pythonhosted.org/packages/2e/d6/9546995fdb76c5a2b5457480768102869c43cc634a79fa2880933c4b76a6/wxtwitterbot-1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-02 06:00:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "karjanme",
"github_project": "wx-twitter-bot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "wxtwitterbot"
}
JSON
