Skip to main content

A Fidus Writer plugin to allow publishing of books to Github

Project description

A plugin to export books to github

This plugin is currently in early-stage development. It has not reached production level quality yet.

To install:

  1. Make sure you have installed the fiduswriter-books plugin and you have updated both fiduswriter and fiduswriter-books to the latest 3.9.x patch release.

  2. Install this plugin (for example by running pip install fiduswriter-github-export).

  3. In your configuration.py file, add “github_export” and “allauth.socialaccount.providers.github” to INSTALLED_APPS.

  4. Set up github as one of the connected login options. See instructions here: https://django-allauth.readthedocs.io/en/latest/providers.html#github . The callback URL will be in the format https://DOMAIN.NAME/api/github/github/login/callback/

  5. In your configuration.py file, make sure to add repo rights for the github connector like this:

    SOCIALACCOUNT_PROVIDERS = {
        'github': {
            'SCOPE': [
                'repo',
                'user:email',
            ],
        }
    }

To use:

  1. Login to your Fidus Writer instance using github, or login with a regular account and connect a Github account on the profile page (https://DOMAIN.NAME/user/profile/)

  2. Go to the books overview page.

  3. Enter a book to set the github settings for the book.

  4. Select the book in the overview and export to github via the dropdown menu.

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

fiduswriter-github-export-3.10.5.tar.gz (30.9 kB view details)

Uploaded Source

File details

Details for the file fiduswriter-github-export-3.10.5.tar.gz.

File metadata

  • Download URL: fiduswriter-github-export-3.10.5.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.0.1 pkginfo/1.4.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.7

File hashes

Hashes for fiduswriter-github-export-3.10.5.tar.gz
Algorithm Hash digest
SHA256 bf5caad9d9732ddc46f0dbf4bec0c4904b5b15783467587d003e8ca036ddf53a
MD5 53fa14ebddb79e9bc818b6f2fae585bb
BLAKE2b-256 d37406ed745e700365dc4cb2c1d085e0e548ccda21e8666faf721ad228c15c7d

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