Browse Source

Clean up docs and packaging

Signed-off-by: Amy Aronsohn <WagThatTail@Me.com>
master 0.4.1
Amelia A 3 years ago
parent
commit
ad3e61ef01
Signed by: amy GPG Key ID: 70C320ABA95D38C1
  1. 14
      LICENSE.txt
  2. 11
      README.md
  3. 23
      setup.py
  4. 2
      tootlogger.toml.example

14
LICENSE.txt

@ -1,2 +1,12 @@
Be Gay
Do Crimes
Copyright (c) Amelia Aronsohn.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

11
README.md

@ -14,21 +14,21 @@ If you miss a day of running this it, it will backfill up to the pagination limi
1. Install the [DayOne Command Line Interface](http://help.dayoneapp.com/tips-and-tutorials/command-line-interface-cli)
1. Install tootlogger with `pip3 install tootlogger`
## Setup
You will need to manually generate your access token and create a config file
1. Log into your mastodon instance
1. go to `/settings/applications` and create the new app.
1. Log into your mastodon instance
1. go to `/settings/applications` and create the new app
- Read permissions are fine
1. Note down the `access_token`
1. Repeat this for all accounts you want to log
1. Create a config file like the example below (or in this repo) in one of two places
1. `$HOME/.tootlogger.toml`
1. `tootlogger.toml` in the local directory you run the command from.
1. `tootlogger.toml` in the local directory you run the command from
### Config file
```toml
["account_name"]
instance = "https://mastodon.social"
@ -36,7 +36,6 @@ access_token = "really big string"
["cool account @ bofh.lol"]
instance = "https://bofh.lol"
access_token = "different big string"
```
## Usage

23
setup.py

@ -1,6 +1,14 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
""" Setup script """
import setuptools
import versioneer
with open('README.md') as readme_file:
README = readme_file.read()
setuptools.setup(
name='tootlogger',
@ -17,5 +25,20 @@ setuptools.setup(
version=versioneer.get_version(),
cmdclass=versioneer.get_cmdclass(),
include_package_data=True,
license_file="LICENSE.txt",
long_description=README,
long_description_content_type='text/markdown',
zip_safe=False,
classifiers=[
'Development Status :: 4 - Beta',
'Environment :: Console',
'Intended Audience :: End Users/Desktop',
'License :: OSI Approved :: BSD License',
'Natural Language :: English',
'Operating System :: MacOS :: MacOS X',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python',
'Topic :: Utilities',
]
)

2
tootlogger.toml.example

@ -1,3 +1,3 @@
["account_name"]
instance = "https://mastadon.social"
access_token = "You really need this"
access_token = "You really need this"
Loading…
Cancel
Save