Skip to main content

Automate taking notes

Project description

autonote

codecov

Description

Automate creating daily, weekly, monthly, and quarterly manual repetitive documents:

  1. Daily: daily journal, habit tracker
  2. Weekly: weekly report
  3. Monthly: monthly report
  4. Quarterly: quarterly review

Prerequisite

  1. Confluence API Token

    export CONFLUENCE_URL=https://xxx.atlassian.net
    export CONFLUENCE_USERNAME=<yourname>@domain.com
    export CONFLUENCE_PASSWORD=<TOKEN>
    
  2. Notion Integration Token

    export NOTION_INTEGRATION_TOKEN=xxx
    

    Please do not forget to share the target database/page with your integration

Installation

pip install autonote

Usage Example (Notion: Create a page from a template.)

  1. Create a template page.

  2. Prepare Python script.

    from autonote.notion import NotionClient
    
    client = NotionClient()
    
    kwargs = {
        "Date": {"start": "2023-02-04", "end": "2023-02-10"},
        "replace_rules": [
            {
                "block_types": ["heading_1"],  # target blocks to apply replacement
                "replace_str": "YYYY/MM/DD",  # replacement string match
                "replace_type": "datetime",  # currently only support "datetime"
                "date_format": "%Y/%m/%d",  # used to parse `start_date` and generate string from datetime when interpolating
                "start_date": "2023/02/04",  # start date
                "increment": True,  # if true, increment 1 day every time replacement is executed
            },
        ],
    }
    client.create_page_from_template(
        template_id="a7cc4f73460c4b9fa82be8d4ed74d8ca",
        title="weekly note",
        override=True,
        **kwargs
    )
    
  3. Run the script.

    pip install autonote
    python main.py
    

    Generated page:

For more examples, please check examples.

Credits

autonote was created with cookiecutter and the py-pkgs-cookiecutter template.

License

autonote was created by Masato Naka. It is licensed under the terms of the MIT license.

References

  1. Atlassian Python API Confluence module
  2. notion-client
  3. Notion API

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autonote-0.5.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

autonote-0.5.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file autonote-0.5.1.tar.gz.

File metadata

  • Download URL: autonote-0.5.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for autonote-0.5.1.tar.gz
Algorithm Hash digest
SHA256 8cbb8276afd847155b9473780ad83606379c8b6473bca09c038bdb7e64005ce0
MD5 47046c7406949bede1b8c095fc332425
BLAKE2b-256 6ec7b7163d5714a6353a1497709959c27254a0f86fb057cbdd654de5cdc14e2e

See more details on using hashes here.

File details

Details for the file autonote-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: autonote-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for autonote-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4150c752aee81f85c880b73abd4944a3d745bcb0702734430cc4fead02ceb763
MD5 7edf8ce31d8d649ce9ceeff63461c162
BLAKE2b-256 1c5b47c14aac2205ea7cff30a0dbe4b8d651e5ac8f0bc5a2a2070ebb328c28f1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page