{
    "info": {
        "author": "Varia members",
        "author_email": "info@varia.zone",
        "bugtrack_url": null,
        "classifiers": [
            "Environment :: Console",
            "Programming Language :: Python :: 3"
        ],
        "description": "etherpump\n=========\n\n[![PyPI version](https://badge.fury.io/py/etherpump.svg)](https://badge.fury.io/py/etherpump)\n[![GPL license](https://img.shields.io/badge/license-GPL-brightgreen.svg)](https://git.vvvvvvaria.org/varia/etherpump/src/branch/master/LICENSE.txt)\n\n*Pumping text from etherpads into publications*\n\nA command-line utility that extends the multi writing and publishing functionalities of the [etherpad](http://etherpad.org/) by exporting the pads in multiple formats.\n\nMany pads, many networks\n------------------------\n\n*Etherpump* is a fork of [*etherpump*](https://gitlab.constantvzw.org/aa/etherpump), a command line tool written by [Michael Murtaugh](http://automatist.org/) that converts etherpad pages to files. This fork is made out of curiosities in the tool, a wish to study it and shared sparks of enthusiasm to use it in different situations within Varia.\n\nEtherpump is a stretched version of etherpump. It is a playground in which we would like to add features to the initial tool that diffuse actions of *dumping* into *pumping*. So most of all, etherpump is a work-in-progress, exploring potential uses of etherpads to edit, structure and publish various types of content.\nAdded features are:\n\n* opt-in publishing with the `__PUBLISH__` magic word\n* the `publication` command, that listens to custom magic words such as `__RELEARN__`\n\nSee the [Change log / notes ](#change-log--notes) section for further changes.\n\netherpump is a tool that is used from the command line. It dumps all pads of one etherpad installation to a folder, saving them as different text files, such as plain text and HTML. It also creates an index file, that allows one to easily navigate through the list of pads. etherpump follows a document-driven idea of publishing, which means that it converts pads as database entries into pads as files. This seems to be a redundant act of copying, but is actually an important in-between step that allows for many different publishing projects and experiments.\n\nWe started to get to know etherpump through various editions of Relearn and/or the worksessions organized by Constant. Collaborative writing on an etherpad has been an important ingredient for these situations. The habit of using pads branched into the day-to-day practice of Varia, where we use etherpads for all sorts of things, ranging from organising remote-meetings with 10+ people, to writing and designing PDF documents collaboratively.\n\nAfter installing etherpump on the Varia server, we collectively decided to not want to publish pads by default. Discussions in the group around the use of etherpads, privacy and ideas of what publishing means, led to a need to have etherpump only start the indexing work after it recognizes a `__PUBLISH__` marker on a pad. We decided to work on a `__PUBLISH__ vs. __NOPUBLISH__` branch of etherpump, which we now fork into **etherpump**.\n\nChange log / notes\n==================\n\n**October 2019**\n\nImprove `etherpump --help` handling to make it easier for new users.\n\nAdded the `python-dateutil` and `pypandoc` dependencies\n\nAdded a fancy progress bar with `tqdm` for long running `etherpump pull --all` calls\n\nStarted with the experimental library API.\n\n**September 2019**\n\nForking *etherpump* into *etherpump*.\n\n<https://git.vvvvvvaria.org/varia/etherpump>\n\nMigrating the source code to Python 3.\n\nIntegrate PyPi publishing with setuptools.\n\n-----\n\n**May - September 2019**\n\netherpump is used to produce the *Ruminating Relearn* section of the Network Of One's Own 2 (NOOO2) publication.\n\nA new command is added to make a web publication, based on the custom magic word `__RELEARN__`.\n\n-----\n\n**June 2019**\n\nMultiple conversations around etherpump emerged during Relearn Curved in Varia, Rotterdam.\n\nIncluding the idea of executable pads (*etherhooks*), custom magic words, a federated snippet protocol (*etherstekje*) and more.\n\n<https://varia.zone/relearn-2019.html>\n\n-----\n\n**April 2019**\n\nInstallation of etherpump on the Varia server.\n\n<https://etherpump.vvvvvvaria.org/>\n\n-----\n\n**March 2019**\n\nThe `__PUBLISH__ vs. __NOPUBLISH__` was added to the etherpump repository by *decentral1se*.\n\n<https://gitlab.constantvzw.org/aa/etherpump/issues/3>\n\n-----\n\nOriginally designed for use at: [Constant](http://etherdump.constantvzw.org/).\n\nMore notes can be found in the [git repository of etherdump](https://gitlab.constantvzw.org/aa/etherdump).\n\n\nInstall etherpump\n=================\n\n`$ pip install etherpump`\n\nEtherpump only supports Python 3.\n\nCommand-line example\n--------------------\n\n```\n$ mkdir mydump\n$ cd myddump\n$ etherpump init\n```\n\nThe program then interactively asks some questions:\n\n> Please type the URL of the etherpad:\n> https://pad.vvvvvvaria.org/\n\nThe APIKEY is the contents of the file APIKEY.txt in the etherpad folder.\n\n> Please paste the APIKEY:\n> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n\nThe settings are placed in a file called `.etherpump/settings.json` and are used (by default) by future commands.\n\nLibrary API Example\n-------------------\n\nEtherpump can be used as a library.\n\nAll commands can be imported and run programmatically.\n\n```python\n>>> from etherpump.api import pull\n>>> pull(['--all', '--publish-opt-in', '--publish', '__PUB_CLUB__'])\n```\n\nSubcommands\n----------\n\nTo see all available subcommands, run:\n\n`$ etherpump --help`\n\nFor help on each individual subcommand, run:\n\n`$ etherpump revisionscount --help`\n\nPublishing\n----------\n\n* `pip install twine`\n* Bump the version number in `etherpump/__init__.py` following [\"semver\"](https://semver.org/) conventions\n* Run `make publish`\n\nYou should have a [PyPi](https://pypi.org/) account and be added as an owner/maintainer on the [etherpump package](https://pypi.org/project/etherpump/).\n\nMaintenance utilities\n---------------------\n\nTools to help things stay tidy over time.\n\n```bash\n$ pip install flake8 isort black\n$ make format\n$ make lint\n```\n\nPlease see the following links for further reading:\n\n* http://flake8.pycqa.org\n* https://isort.readthedocs.io\n* https://black.readthedocs.io\n\nKeeping track of Etherpad-lite\n------------------------------\n\n* [Etherpad-lite API documentation](https://etherpad.org/doc/v1.7.5/)\n* [Etherpad-lite releases](https://github.com/ether/etherpad-lite/releases)\n\nLicense\n=======\n\nGNU AFFERO GENERAL PUBLIC LICENSE, Version 3.\n\nSee [LICENSE.txt](./LICENSE.txt).\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://git.vvvvvvaria.org/varia/etherpump",
        "keywords": "",
        "license": "GPLv3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "etherpump",
        "package_url": "https://pypi.org/project/etherpump/",
        "platform": "any",
        "project_url": "https://pypi.org/project/etherpump/",
        "project_urls": {
            "Homepage": "https://git.vvvvvvaria.org/varia/etherpump"
        },
        "release_url": "https://pypi.org/project/etherpump/0.0.8/",
        "requires_dist": [
            "html5lib",
            "jinja2",
            "python-dateutil",
            "pypandoc",
            "tqdm",
            "requests"
        ],
        "requires_python": "",
        "summary": "Etherpump: pumping text from etherpads into publications",
        "version": "0.0.8"
    },
    "last_serial": 5941702,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e05c5850b0a7acff1cf6036bdd202f3c",
                    "sha256": "5498b619e855789a99657dc7b218435b9d911ffd8cd21ab88089bf509c7bad1e"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e05c5850b0a7acff1cf6036bdd202f3c",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 47699,
                "upload_time": "2019-09-25T19:48:11",
                "url": "https://files.pythonhosted.org/packages/89/8b/d7dff119e67836c3ed5c6123b30898d1b5b1f984c9e240cd04167ab839a5/etherpump-0.0.1-py3-none-any.whl"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5ddb2f79200324414a3ba4046c0f54f4",
                    "sha256": "0bbf2777efcd1fc51037a6f5521038d2d38796b2447572b8010af8c394da5c50"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "5ddb2f79200324414a3ba4046c0f54f4",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 49875,
                "upload_time": "2019-09-25T19:49:53",
                "url": "https://files.pythonhosted.org/packages/e6/cc/f7d53599c2a52a11c6a30057ee22466eeaef96ce5734c181bae79960368a/etherpump-0.0.2-py3-none-any.whl"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ed139defd734e8720a2f4441474d23a8",
                    "sha256": "2122083f510a357445a6207a7309630815fa1eebddc457b3876a742f59501f3a"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ed139defd734e8720a2f4441474d23a8",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 51239,
                "upload_time": "2019-09-27T22:18:04",
                "url": "https://files.pythonhosted.org/packages/f6/d8/1bf1a6c19bb4324cba524d25ee153d20aff53283c84f99cfcad33d8fed6e/etherpump-0.0.3-py3-none-any.whl"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d60e268c7bbf75968ff0e9437883c1ac",
                    "sha256": "12645af0dfbdda49c73cebdaf65e87b6f50b5f88632041f82c1fbd7346212607"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d60e268c7bbf75968ff0e9437883c1ac",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 50745,
                "upload_time": "2019-10-07T17:20:28",
                "url": "https://files.pythonhosted.org/packages/87/37/0c19c27f51beeb8ef6169d956a095c411bc79e2b01610fe7174526668433/etherpump-0.0.4-py3-none-any.whl"
            }
        ],
        "0.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4bc6f63d900163de1a1c5ecc3917611f",
                    "sha256": "f2c5829256174168f307387d670e505d2f4e767130a189fc6f276063922f17fb"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.5-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4bc6f63d900163de1a1c5ecc3917611f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 52945,
                "upload_time": "2019-10-07T20:24:12",
                "url": "https://files.pythonhosted.org/packages/de/04/b1db73acb691568adb7c532ae8c910e0e36767284222b2873d411e942abe/etherpump-0.0.5-py3-none-any.whl"
            }
        ],
        "0.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c266e5524ea37cc432bd6fa43c21b0a4",
                    "sha256": "cd8cdb4490360fcdf7e854620c7d9c945a7be2d0de2a49bf3f08654423cf2354"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.6-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c266e5524ea37cc432bd6fa43c21b0a4",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 52898,
                "upload_time": "2019-10-07T20:43:07",
                "url": "https://files.pythonhosted.org/packages/32/b2/07a89672cfd951a4e8039354c7d0913dc3e136a8b5ece8eac1f6a991429c/etherpump-0.0.6-py3-none-any.whl"
            }
        ],
        "0.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "facaecdd92ba5196aa35adb131eddd08",
                    "sha256": "84c41f769e64713cd0c80527e559a8b8c0ede0d98ce0ac854e2485ae8b6fbdb2"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.7-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "facaecdd92ba5196aa35adb131eddd08",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 52968,
                "upload_time": "2019-10-07T21:42:00",
                "url": "https://files.pythonhosted.org/packages/0c/1e/6241306aa86107dd51a91c59b73ca939ca92d3f3216f129c8f18ec61af5d/etherpump-0.0.7-py3-none-any.whl"
            }
        ],
        "0.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "804e56f123b34554e5b2522b26e59261",
                    "sha256": "2ce6c3e785e0776f0987b38049663541c865182f46ee0187eefd666c059e5b08"
                },
                "downloads": -1,
                "filename": "etherpump-0.0.8-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "804e56f123b34554e5b2522b26e59261",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 52937,
                "upload_time": "2019-10-07T21:52:20",
                "url": "https://files.pythonhosted.org/packages/9a/97/90a84b7d2f998ad0bb23ebd9dcc91a56b01611dc7812c1789a1b61940526/etherpump-0.0.8-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "804e56f123b34554e5b2522b26e59261",
                "sha256": "2ce6c3e785e0776f0987b38049663541c865182f46ee0187eefd666c059e5b08"
            },
            "downloads": -1,
            "filename": "etherpump-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "804e56f123b34554e5b2522b26e59261",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 52937,
            "upload_time": "2019-10-07T21:52:20",
            "url": "https://files.pythonhosted.org/packages/9a/97/90a84b7d2f998ad0bb23ebd9dcc91a56b01611dc7812c1789a1b61940526/etherpump-0.0.8-py3-none-any.whl"
        }
    ]
}