| Name | nyantip JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | Nyancoin tip bot for Reddit. |
| upload_time | 2024-04-12 16:44:50 |
| maintainer | None |
| docs_url | None |
| author | Bryce Boe |
| requires_python | ~=3.6 |
| license | GPL |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# It's nyantip!
## Getting started
### Install
__Note__: If the following doesn't work, ensure you have pip installed:
<https://packaging.python.org/guides/installing-using-linux-tools/>
```sh
pip install nyantip
```
If you would like to make encrypted backups, then install via:
```sh
pip install nyantip[gpg]
```
### Database
Create a new MySQL database instance and run included SQL file `database.sql`
to create necessary tables. Create a MySQL user and grant it all privileges on
the database.
```sh
echo "create database nyantip" | mysql && mysql nyantip < database.sql
```
### NyanCoin Daemons
Download nyancoin. Create a configuration file for it in
`~/.nyancoin/nyancoin.conf` specifying `rpcuser`, `rpcpassword`, `rpcport`, and
`server=1`, then start the daemon. It will take some time for the daemon to
download the blockchain, after which you should verify that it's accepting
commands, e.g., `nyancoin getinfo` and `nyancoin listaccounts`.
### Reddit Account
Create a dedicated Reddit account for your bot, and prepare an OAuth
script-type application as described here:
<https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example#first-steps>
The bot should be granted "Manage Users" and "Manage Wiki Pages" moderator
permissions on the target subreddit.
### Configuration Files
Copy the sample configuration file `nyantip-sample.yml` to
`~/.config/nyantip.yml`. Make any necessary edits.
### Run
```sh
nyantip
```
### Create Backup
```sh
nyantip backup
```
The backup will be saved in your current directory as
`backup_nyantip_YYYYmmDDHHMM.zip`, or with the added `.gpg` suffix if a value
for `backup_passphrase` was set in your config file.
## History
`nyantip` was originally a fork of mohland's
[dogetipbot](https://github.com/mohland/dogetipbot), which in turn is a fork of
vindimy's [ALTcointip](https://github.com/vindimy/altcointip).
Raw data
{
"_id": null,
"home_page": null,
"name": "nyantip",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Bryce Boe",
"author_email": "bbzbryce@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/50/7b6c679ed892312b1f00136416907f7b19870c45c785189506d0e66b3083/nyantip-0.8.tar.gz",
"platform": null,
"description": "# It's nyantip!\n\n## Getting started\n\n### Install\n\n__Note__: If the following doesn't work, ensure you have pip installed:\n<https://packaging.python.org/guides/installing-using-linux-tools/>\n\n```sh\npip install nyantip\n```\n\nIf you would like to make encrypted backups, then install via:\n\n```sh\npip install nyantip[gpg]\n```\n\n### Database\n\nCreate a new MySQL database instance and run included SQL file `database.sql`\nto create necessary tables. Create a MySQL user and grant it all privileges on\nthe database.\n\n```sh\necho \"create database nyantip\" | mysql && mysql nyantip < database.sql\n```\n\n### NyanCoin Daemons\n\nDownload nyancoin. Create a configuration file for it in\n`~/.nyancoin/nyancoin.conf` specifying `rpcuser`, `rpcpassword`, `rpcport`, and\n`server=1`, then start the daemon. It will take some time for the daemon to\ndownload the blockchain, after which you should verify that it's accepting\ncommands, e.g., `nyancoin getinfo` and `nyancoin listaccounts`.\n\n### Reddit Account\n\nCreate a dedicated Reddit account for your bot, and prepare an OAuth\nscript-type application as described here:\n<https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example#first-steps>\n\nThe bot should be granted \"Manage Users\" and \"Manage Wiki Pages\" moderator\npermissions on the target subreddit.\n\n### Configuration Files\n\nCopy the sample configuration file `nyantip-sample.yml` to\n`~/.config/nyantip.yml`. Make any necessary edits.\n\n### Run\n\n```sh\nnyantip\n```\n\n### Create Backup\n\n```sh\nnyantip backup\n```\n\nThe backup will be saved in your current directory as\n`backup_nyantip_YYYYmmDDHHMM.zip`, or with the added `.gpg` suffix if a value\nfor `backup_passphrase` was set in your config file.\n\n## History\n\n`nyantip` was originally a fork of mohland's\n[dogetipbot](https://github.com/mohland/dogetipbot), which in turn is a fork of\nvindimy's [ALTcointip](https://github.com/vindimy/altcointip).\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Nyancoin tip bot for Reddit.",
"version": "0.8.0",
"project_urls": {
"Source Code": "https://github.com/bboe/nyantip"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c6eaa345825c96e52548fdf862432e68262680944e285fa7077fbf96899b8cd",
"md5": "c7898e408baea601c0ffa92310241bf1",
"sha256": "a8ab8f774661743da7494131937075c5261b1195a40c97f44703f2b45a28c654"
},
"downloads": -1,
"filename": "nyantip-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7898e408baea601c0ffa92310241bf1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.6",
"size": 31825,
"upload_time": "2024-04-12T16:44:48",
"upload_time_iso_8601": "2024-04-12T16:44:48.451520Z",
"url": "https://files.pythonhosted.org/packages/5c/6e/aa345825c96e52548fdf862432e68262680944e285fa7077fbf96899b8cd/nyantip-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da507b6c679ed892312b1f00136416907f7b19870c45c785189506d0e66b3083",
"md5": "1e14f4bcf87a789edae85fc4e6dc79ac",
"sha256": "0ec2b356ec3ac54d0f5feb25e6c62a9c8c420592a1d02a5a528dd921435e2a3c"
},
"downloads": -1,
"filename": "nyantip-0.8.tar.gz",
"has_sig": false,
"md5_digest": "1e14f4bcf87a789edae85fc4e6dc79ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.6",
"size": 25854,
"upload_time": "2024-04-12T16:44:50",
"upload_time_iso_8601": "2024-04-12T16:44:50.273612Z",
"url": "https://files.pythonhosted.org/packages/da/50/7b6c679ed892312b1f00136416907f7b19870c45c785189506d0e66b3083/nyantip-0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 16:44:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bboe",
"github_project": "nyantip",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nyantip"
}
