Skip to content

Switch to setuptools and wheels #606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 9, 2017
Merged

Switch to setuptools and wheels #606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1df5a94
Switch to setuptools.
waylan Dec 9, 2017
a0c8d1b
Build and upload wheels for releases.
waylan Dec 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
recursive-include bin *
recursive-include markdown *.py
recursive-include docs *
recursive-include tests *.txt *.html *.cfg *.py
Expand Down
34 changes: 0 additions & 34 deletions bin/markdown_py
View file
Open in desktop

This file was deleted.

63 changes: 11 additions & 52 deletions docs/install.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
[nosetests]

[bdist_wheel]
universal=1

[metadata]
license_file = LICENSE.md
72 changes: 20 additions & 52 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
#!/usr/bin/env python

from __future__ import with_statement
import sys
from setuptools import setup
import os
from distutils.core import setup
from distutils.command.install_scripts import install_scripts
import imp


Expand All @@ -14,54 +11,23 @@ def get_version():
fp, pathname, desc = imp.find_module('__version__', [path])
try:
v = imp.load_module('__version__', fp, pathname, desc)
return v.version, v.version_info
finally:
fp.close()

dev_status_map = {
'alpha': '3 - Alpha',
'beta': '4 - Beta',
'rc': '4 - Beta',
'final': '5 - Production/Stable'
}
if v.version_info[3] == 'alpha' and v.version_info[4] == 0:
status = '2 - Pre-Alpha'
else:
status = dev_status_map[v.version_info[3]]
return v.version, v.version_info, status

version, version_info = get_version()

# Get development Status for classifiers
dev_status_map = {
'alpha': '3 - Alpha',
'beta': '4 - Beta',
'rc': '4 - Beta',
'final': '5 - Production/Stable'
}
if version_info[3] == 'alpha' and version_info[4] == 0:
DEVSTATUS = '2 - Pre-Alpha'
else:
DEVSTATUS = dev_status_map[version_info[3]]

# The command line script name. Currently set to "markdown_py" so as not to
# conflict with the perl implimentation (which uses "markdown"). We can't use
# "markdown.py" as the default config on some systems will cause the script to
# try to import itself rather than the library which will raise an error.
SCRIPT_NAME = 'markdown_py'


class md_install_scripts(install_scripts):

""" Customized install_scripts. Create markdown_py.bat for win32. """

def run(self):
install_scripts.run(self)

if sys.platform == 'win32':
try:
script_dir = os.path.join(sys.prefix, 'Scripts')
script_path = os.path.join(script_dir, SCRIPT_NAME)
bat_str = '@"%s" "%s" %%*' % (sys.executable, script_path)
bat_path = os.path.join(
self.install_dir, '%s.bat' % SCRIPT_NAME
)
f = open(bat_path, 'w')
f.write(bat_str)
f.close()
print('Created: %s' % bat_path)
except Exception:
_, err, _ = sys.exc_info() # for both 2.x & 3.x compatability
print('ERROR: Unable to create %s: %s' % (bat_path, err))
version, version_info, DEVSTATUS = get_version()


long_description = '''
Expand All @@ -72,7 +38,7 @@ def run(self):
supported by the `Available Extensions`_.

.. _Markdown: http://daringfireball.net/projects/markdown/
.. _Features: https://Python-Markdown.github.io#Features
.. _Features: https://Python-Markdown.github.io#features
.. _`Available Extensions`: https://Python-Markdown.github.io/extensions/

Support
Expand All @@ -85,11 +51,12 @@ def run(self):
.. _`bug tracker`: http://github.com/Python-Markdown/markdown/issues
'''


setup(
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 All @@ -98,9 +65,10 @@ def run(self):
maintainer_email='waylan.limberg@icloud.com',
license='BSD License',
packages=['markdown', 'markdown.extensions'],
scripts=['bin/%s' % SCRIPT_NAME],
cmdclass={
'install_scripts': md_install_scripts
entry_points={
'console_scripts': [
'markdown = markdown.__main__:run',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should not this be markdown_py = ...? From Debian packaging perspective, I would still like to avoid conflicts with the Perl implementation.

Copy link
Member Author

@waylan waylan Dec 10, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you're correct, it should. I forgot about that. Feel free to push a fix for that yourself. Probably should restore the old comment to remind us as well.

]
},
classifiers=[
'Development Status :: %s' % DEVSTATUS,
Expand Down