Metadata-Version: 1.1
Name: mwdoc
Version: 0.1.0
Summary: Allow to easily version mediawiki pages.
Home-page: https://github.com/jcfr/mwdoc#readme
Author: Jean-Christophe Fillion-Robin
Author-email: jchris.fillionr@kitware.com
License: Apache
Description: Mwdoc
        =====
        
        Overview
        --------
        
        Think of [mwdoc](https://pypi.python.org/pypi/mwdoc) as a tool that allows to easily version mediawiki pages.
        
        For example, pages like:
        
            Documentation/0.2/mypage
            Template:Documentation/0.2/mytemplate
        
        ... can be automatically created from:
        
            Documentation/0.1/mypage
            Template:Documentation/0.1/mytemplate
        
        
        Installation
        ------------
        
        Installing `mwdoc` will automatically install the required dependencies.
        
        ```
        pip install mwdoc
        ```
        
        Usage
        -----
        
        * Create pages:
        
        ``` python
        import mwdoc
        doc = mwdoc.Documentation('somewhere.org', '/w/')
        doc.login('john', 'password')
        doc.createPage('0.1', 'mypage', 'This is content of my page', 'Documentation')
        doc.createPage('0.1', 'mytemplate', 'This is content of my template', 'Template:Documentation')
        ```
        
        
        * Version pages from 0.1 to 0.2:
        
        ``` python
        import mwdoc
        doc = mwdoc.Documentation('somewhere.org', '/w/')
        doc.login('john', 'password')
        doc.versionPages('0.1', '0.2', ['Documentation', 'Template:Documentation'])
        ```
        
        
        * List pages:
        
        ``` python
        import mwdoc
        doc = mwdoc.Documentation('somewhere.org', '/w/')
        doc.login('john', 'password')
        pages = doc.listPages('Documentation')
        for page in pages:
           print(page)
        templatepages = doc.listPages('Template:Documentation')
        for page in templatepages:
           print(page)
        ```
        
        * Delete pages:
        
        ``` python
        import mwdoc
        doc = mwdoc.Documentation('somewhere.org', '/w/')
        doc.login('john', 'password')
        pages = doc.listPages('Documentation')
        for page in pages: 
            page.delete()
        ```
        
        Dependencies
        ------------
        
        * [mwclient][mwclient], the client to [MediaWiki API][mwapi]
        
        
        Test
        ----
        
        Do **NOT** run this test against a production installation. We mean it.
        
        The test will create pages, version them and delete them afterward.
        
        To run the test:
        
        ```
        git clone git://github.com/jcfr/mwdoc && cd $_
        pip install -r requirements.txt
        python -m unittest test_mwdoc
        ```
        
        It will then ask for:
        
        * Hostname (e.g `localhost`)
        * Path (e.g `/w/`)
        * Username
        * Password
        
        
        Contributing
        ------------
        
        Once you've made your great commits:
        
        1. [Fork][fk] mwdoc
        2. Create a topic branch - `git checkout -b my_branch`
        3. Push to your branch - `git push origin my_branch`
        4. Create an [Issue][is] with a link to your branch
        5. That's it!
        
        
        Make a new release
        ------------------
        
        A core developer should use the following steps to create a release of **mwdoc**.
        
        0. Configure `~/.pypirc` as described [here](https://packaging.python.org/distributing/#uploading-your-project-to-pypi).
        
        1. Make sure that all tests are passing.
        
        2. Tag the release. Requires a GPG key with signatures. For version *X.Y.Z*:
        
        ```bash
        git tag -s -m "mwdoc X.Y.Z" X.Y.Z upstream/master
        ```
        
        3. Create the source tarball and binary wheels:
        
        ```bash
        git checkout master
        git fetch upstream
        git reset --hard upstream/master
        rm -rf dist/
        python setup.py sdist bdist_wheel
        ```
        
        4. Upload the packages to the testing PyPI instance::
        
        ```bash
        twine upload --sign -r pypitest dist/*
        ```
        
        5. Check the [PyPI testing package page](https://testpypi.python.org/pypi/mwdoc/).
        
        6. Upload the packages to the PyPI instance::
        
        ```bash
        twine upload --sign dist/*
        ```
        
        7. Check the [PyPI package page](https://pypi.python.org/pypi/mwdoc/).
        
        8. Make sure the package can be installed::
        
        ```bash
        mkvirtualenv test-pip-install
        pip install mwdoc
        rmvirtualenv test-pip-install
        ```
        
        Credits
        -------
        
        Please see the GitHub project page at https://github.com/jcfr/mwdoc/graphs/contributors
        
        Meta
        ----
        
        * PyPI: <https://pypi.python.org/pypi/mwdoc>
        * Code: `git clone git://github.com/jcfr/mwdoc.git`
        * Home: <http://github.com/jcfr/mwdoc#readme>
        * Bugs: <http://github.com/jcfr/mwdoc/issues>
        
        License
        -------
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
        [fk]: http://help.github.com/forking/
        [is]: http://github.com/jcfr/mwdoc/issues
        [mwclient]: http://sourceforge.net/apps/mediawiki/mwclient
        [mwapi]: https://www.mediawiki.org/wiki/API
        
        
Keywords: mediawiki wikipedia
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
