diff --git a/README.md b/README.md new file mode 100644 index 0000000..6fde9fe --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# dl-wp-pdf + +This program just downloads a Wikipedia article as a PDF by using the Wikipedia REST API. + +## Installation + +``` shell +pipx install dl-wp-pdf +``` + +## Usage + +Use the Wikipedia article's name as the argument to `dl-wp-pdf`. For example, if the article's URL is `https://en.wikipedia.org/wiki/Python_(programming_language)`, then the argument for `dl-wp-pdf` would be `"Python_(programming_language)"`. + +``` shell +cd ~/downloads +dl-wp-pdf "Python_(programming_language)" + +Output: +--> /home/jas/downloads/Python_(programming_language).pdf +``` + +> Note: make sure to use quotes around the article name in the argument to `dl-wp-pdf`. diff --git a/README.org b/README.org deleted file mode 100644 index fc50eff..0000000 --- a/README.org +++ /dev/null @@ -1,23 +0,0 @@ -#+title: dl-wp-pdf - -This program just downloads a Wikipedia article as a PDF by using the Wikipedia REST API. - -** Installation -#+BEGIN_SRC shell -pipx install dl-wp-pdf -#+END_SRC - -** Usage -Use the Wikipedia article's name as the argument to ~dl-wp-pdf~. For example, if the article's URL is ~https://en.wikipedia.org/wiki/Python_(programming_language)~, then the argument for ~dl-wp-pdf~ would be ~Python_(programming_language)~. - -#+BEGIN_SRC shell -cd ~/downloads -dl-wp-pdf "Python_(programming_language)" - -Output: ---> /home/jas/downloads/Python_(programming_language).pdf -#+END_SRC - -#+BEGIN_QUOTE -Note: make sure to use quotes around the article name in the argument. -#+END_QUOTE diff --git a/pyproject.toml b/pyproject.toml index dde10aa..44f4dff 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,25 @@ [project] name = "dl-wp-pdf" -version = "0.3" +version = "0.7" +authors = [ + { name="Jeffrey Serio", email="hyperreal@fedoraproject.org" }, +] +description = "Download Wikipedia articles as PDF" +readme = "README.md" +requires-python = ">=3.10" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", + "Operating System :: OS Independent", +] [project.scripts] dl-wp-pdf = "dl_wp_pdf.py:main" +[project.urls] +Homepage = "https://codeberg.org/hyperreal/dl-wp-pdf" +Issues = "https://codeberg.org/hyperreal/dl-wp-pdf/issues" + [build-system] requires = ["hatchling"] build-backend = "hatchling.build"