Skip to content

Commit

Permalink
Build and upload wheels for releases.
Browse files Browse the repository at this point in the history
Update install docs.
  • Loading branch information
waylan committed Dec 9, 2017
1 parent 52b8da8 commit 193c509
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 55 deletions.
63 changes: 11 additions & 52 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,25 @@
title: Installation
title: Installation

Installing Python-Markdown
==========================
# Installing Python-Markdown

The Easy Way
------------
## The Easy Way

The easiest way to install Python-Markdown is simply to type one of the
following commands from the command line as an Admin/Root user:
The easiest way to install Python-Markdown is simply to type the
following command from the command line:

```bash
pip install markdown
```

or

```bash
easy_install markdown
```

That's it! You're ready to [use](reference.md) Python-Markdown. Enjoy!

Installing on Windows {: #windows }
-----------------------------------

Download the Windows installer (`.exe`) from
[PyPI](http://pypi.python.org/pypi/Markdown)

Double-click the file and follow the instructions.

If you prefer to manually install Python-Markdown in Windows, download the
Zip file, unzip it, and on the command line in the directory you unzipped to,
run the following command:

```text
C://path/to/python.exe setup.py install
```

If you plan to use the provided command line script, you need to make sure your
script directory is on your system path. On a typical Python install of Windows
the Scripts directory is `C:\PythonXX\Scripts\` (were "XX" is the Python version
number, i.e., "27"). Adjust the path according to your system and add to your
system path.

Installing on \*nix Systems {: #linux }
---------------------------------------

From the command line do the following (where 2.x is the version number):

```bash
wget http://pypi.python.org/packages/source/M/Markdown/Markdown-2.x.tar.gz
tar xvzf Markdown-2.x.tar.gz
cd markdown-2.x/
sudo python setup.py install
```
For more detailed instructions on installing Python packages, see the
[Installing Packages] tutorial in the [Python Packaging User Guide].

See [PyPI](http://pypi.python.org/pypi/Markdown) for all available versions.
[Installing Packages]: https://packaging.python.org/tutorials/installing-packages/
[Python Packaging User Guide]: https://packaging.python.org/

Using the Git Repository {: #git }
----------------------------------
## Using the Git Repository {: #git }

If you're the type that likes to live on the edge, you may want to keep up with
the latest additions and bug fixes in the repository between releases.
Expand All @@ -67,7 +28,5 @@ get a copy of Python-Markdown from the repository do the following from the
command line:

```bash
git clone git://github.com/Python-Markdown/markdown.git python-markdown
cd python-markdown
python setup.py install
pip install git+https://github.com/Python-Markdown/markdown.git
```
6 changes: 4 additions & 2 deletions makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ install:

.PHONY : deploy
deploy:
python setup.py sdist --formats gztar upload
rm -rf dist
python setup.py bdist_wheel sdist --formats gztar
twine upload dist/*

.PHONY : build
build:
python setup.py sdist --formats gztar
python setup.py bdist_wheel sdist --formats gztar

.PHONY : build-win
build-win:
Expand Down
6 changes: 6 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
[nosetests]

[bdist_wheel]
universal=1

[metadata]
license_file = LICENSE.md
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def get_version():
name='Markdown',
version=version,
url='https://Python-Markdown.github.io/',
download_url='http://pypi.python.org/packages/source/M/Markdown/Markdown-%s.tar.gz' % version,
download_url='http://pypi.python.org/packages/source/M/Markdown/Markdown-%s-py2.py3-none-any.whl' % version,
description='Python implementation of Markdown.',
long_description=long_description,
author='Manfred Stienstra, Yuri takhteyev and Waylan limberg',
Expand Down

0 comments on commit 193c509

Please sign in to comment.