jenkins-bot has submitted this change and it was merged. Change subject: Add proper package specification for PyPI ......................................................................
Add proper package specification for PyPI PyPI likes rst files, so move from .md -> .rst. This should not matter for GitHub. Otherwise mainly small tweaks to make sure the PyPI listing refers to the GitHub master zip. Change-Id: I40252d3cadc7d13dd8d98db8684bb784185f1fdf --- D README.md A README.rst M setup.py 3 files changed, 52 insertions(+), 36 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md deleted file mode 100644 index 06aed08..0000000 --- a/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Pywikibot Framework - -[](http://travis-ci.org/wikimedia/pywikibot-core) - -The pywikibot framework is a Python library that interfaces with the [MediaWiki API](https://www.mediawiki.org/wiki/API). -Also included are various general function scripts that can be adapted for different tasks. - -## Quick start -``` -git clone https://gerrit.wikimedia.org/r/pywikibot/core.git -cd core -git submodule update --init -python pwb.py script_name -``` - -Our [installation guide](https://www.mediawiki.org/wiki/Manual:Pywikipediabot/Installation) has more details for advanced usage. - -## Usage - -If you wish to write your own script it's very easy to get started: - -```python -import pywikibot -site = pywikibot.Site('en', 'wikipedia') # The site we want to run our bot on -page = pywikibot.Page(site, 'Wikipedia:Sandbox') -text = page.text # The current text on the page -page.text = text.replace('foo', 'bar') -page.save('Replacing "foo" with "bar"') # Saves the page -``` - -## Contributing - -Our code is maintained on Wikimedia's [Gerrit installation](https://gerrit.wikimedia.org/), [learn](https://www.mediawiki.org/wiki/Developer_access) how to get started. - diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..e19cdc5 --- /dev/null +++ b/README.rst @@ -0,0 +1,45 @@ +Pywikibot Framework +=================== + +The pywikibot framework is a Python library that interfaces with the +`MediaWiki API <https://www.mediawiki.org/wiki/API>`_. Also included are +various general function scripts that can be adapted for different +tasks. + +Quick start +----------- + +:: + + git clone https://gerrit.wikimedia.org/r/pywikibot/core.git + cd core + git submodule update --init + python pwb.py script_name + +Our `installation +guide <https://www.mediawiki.org/wiki/Manual:Pywikipediabot/Installation>`_ +has more details for advanced usage. + +Usage +----- + +If you wish to write your own script it's very easy to get started: + +:: + + import pywikibot + site = pywikibot.Site('en', 'wikipedia') # The site we want to run our bot on + page = pywikibot.Page(site, 'Wikipedia:Sandbox') + page.text = page.text.replace('foo', 'bar') + page.save('Replacing "foo" with "bar"') # Saves the page + +Contributing +------------ + +Our code is maintained on Wikimedia's `Gerrit installation <https://gerrit.wikimedia.org/>`_, +`learn <https://www.mediawiki.org/wiki/Developer_access>`_ how to get +started. + +.. image:: https://secure.travis-ci.org/wikimedia/pywikibot-core.png?branch=master + :alt: Build Status + :target: http://travis-ci.org/wikimedia/pywikibot-core diff --git a/setup.py b/setup.py index cf14a97..399af0c 100644 --- a/setup.py +++ b/setup.py @@ -54,9 +54,12 @@ subprocess.call([python, "generate_user_files.py"]) setup( - name='Pywikipediabot', + name='pywikibot', version='2.0b1', description='Python Wikipedia Bot Framework', + long_description=open('README.rst').read(), + maintainer='The pywikibot team', + maintainer_email='[email protected]', license='MIT License', packages=['pywikibot'] + \ [package @@ -69,11 +72,13 @@ dependency_links=[ 'https://git.wikimedia.org/zip/?r=pywikibot/externals/httplib2.git&format=gz#egg=httplib2-0.8-pywikibot1' ], + url='https://mediawiki.org/wiki/Pywikibot', + download_url='https://github.com/wikimedia/pywikibot-core/archive/master.zip#egg=pywikibot-2.0b1', test_suite=testcollector, tests_require=test_deps, classifiers=[ 'License :: OSI Approved :: MIT License', - 'Development Status :: 4 - Beta' + 'Development Status :: 4 - Beta', 'Operating System :: OS Independent', 'Intended Audience :: Developers', 'Environment :: Console', -- To view, visit https://gerrit.wikimedia.org/r/132712 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I40252d3cadc7d13dd8d98db8684bb784185f1fdf Gerrit-PatchSet: 4 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Merlijn van Deen <[email protected]> Gerrit-Reviewer: Ladsgroup <[email protected]> Gerrit-Reviewer: Merlijn van Deen <[email protected]> Gerrit-Reviewer: Xqt <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ Pywikibot-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/pywikibot-commits
