Skip to content

Commit aaf83c4

Browse files
committed
Minor edits to README.rst and setup.py to reflect Python 3 compatibility #280
Signed-off-by: Thomas Druez <[email protected]>
1 parent 0059953 commit aaf83c4

File tree

2 files changed

+16
-17
lines changed

2 files changed

+16
-17
lines changed

README.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ Build and tests status
1717
+-------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
1818

1919

20-
2120
The AboutCode toolkit and ABOUT files provide a simple way to document the
2221
(origin and license) and other important or interesting information about
2322
third-party software components that you use in your project.
@@ -42,17 +41,16 @@ https://github.com/nexB/aboutcode-toolkit/blob/master/SPEC
4241

4342
REQUIREMENTS
4443
------------
45-
The AboutCode toolkit is tested with 2.7 on Linux, Mac and Windows.
44+
The AboutCode toolkit is tested with Python 2.7 and 3.6 on Linux, Mac and Windows.
4645
You will need to install a Python interpreter if you do not have one already
4746
installed.
4847

4948
On Linux and Mac, Python is typically pre-installed. To verify which
5049
version may be pre-installed, open a terminal and type::
5150

5251
python --version
53-
python2.7 --version
5452

55-
On Windows or Mac, you can download the latest Python 2.7.x here:
53+
On Windows or Mac, you can download the latest Python here:
5654
https://www.python.org/downloads/
5755

5856
Download the .msi installer for Windows or the .dmg archive for Mac.
@@ -65,7 +63,7 @@ Checkout or download and extract the AboutCode toolkit from:
6563
https://github.com/nexB/aboutcode-toolkit/
6664

6765
To install all the needed dependencies in a virtualenv, run (on posix)::
68-
source configure
66+
source configure
6967
or on windows::
7068
configure
7169

@@ -75,8 +73,8 @@ USAGE
7573
See https://github.com/nexB/aboutcode-toolkit/blob/master/USAGE.rst for USAGE.
7674

7775

78-
TESTS and DEVLOPMENT
79-
--------------------
76+
TESTS and DEVELOPMENT
77+
---------------------
8078
To install all the needed development dependencies, run (on posix)::
8179
source configure etc/conf/dev
8280
or on windows::
@@ -86,7 +84,6 @@ To verify that everything works fine you can run the test suite with::
8684
py.test
8785

8886

89-
9087
HELP and SUPPORT
9188
----------------
9289
If you have a question or find a bug, enter a ticket at:

setup.py

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
from os.path import dirname
1111
from os.path import join
1212
from os.path import splitext
13-
import re
14-
import sys
1513

1614
from setuptools import find_packages
1715
from setuptools import setup
@@ -28,13 +26,17 @@ def read(*names, **kwargs):
2826
name='aboutcode-toolkit',
2927
version='3.0.0.dev6',
3028
license='Apache-2.0',
31-
description=('AboutCode-toolkit is a tool to d_ocument the provenance (origin and license) of '
32-
'third-party software using small text files. '
33-
'Collect inventories, generate attribution documentation.'),
34-
long_description=('AttributeCode provides a simple way to document the'
29+
description=(
30+
'AboutCode-toolkit is a tool to document the provenance (origin and license) of '
31+
'third-party software using small text files. '
32+
'Collect inventories, generate attribution documentation.'
33+
),
34+
long_description=(
35+
'AttributeCode provides a simple way to document the'
3536
'provenance (i.e. origin and license) of software components that'
3637
'you use in your project. This documentation is stored in *.ABOUT'
37-
'files, side-by-side with the documented code.'),
38+
'files, side-by-side with the documented code.'
39+
),
3840
author='Chin-Yeung Li, Jillian Daguil, Thomas Druez, Philippe Ombredanne and others.',
3941
author_email='[email protected]',
4042
url='http://aboutcode.org',
@@ -64,7 +66,7 @@ def read(*names, **kwargs):
6466
'license', 'about', 'metadata', 'package', 'copyright',
6567
'attribution', 'software', 'inventory',
6668
],
67-
# FIXME: we SHOULD NOT use datafiles!!!! whcih is a mine field but
69+
# FIXME: we SHOULD NOT use datafiles!!!! which is a mine field but
6870
# only package data or use a MANIFEST.in instead for a sdist
6971
data_files=[('about',
7072
[
@@ -90,7 +92,7 @@ def read(*names, **kwargs):
9092
'license_expression >= 0.94, < 1.0',
9193
],
9294
extras_require={
93-
":python_version < '3.6'": ['backports.csv'],
95+
":python_version < '3.6'": ['backports.csv'],
9496
},
9597
entry_points={
9698
'console_scripts': [

0 commit comments

Comments
 (0)