Skip to content

Commit 843abb7

Browse files
committed
update documentation, add new test environments for harness
1 parent a652f75 commit 843abb7

File tree

4 files changed

+28
-11
lines changed

4 files changed

+28
-11
lines changed

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
python-stix
22
===========
33

4-
A python library for parsing, manipulating, and generating STIX v1.2 content.
4+
A python library for parsing, manipulating, and generating `Structured Threat Information eXpression (STIX™) <https://stixproject.github.io/>`_ v1.2.0 content.
55

66
:Source: https://github.com/STIXProject/python-stix
7-
:Documentation: http://stix.readthedocs.org
7+
:Documentation: https://stix.readthedocs.io/
88
:Information: https://stixproject.github.io/
99

1010
|travis_badge| |landscape_io_badge| |version_badge|
@@ -24,7 +24,7 @@ Installation
2424
------------
2525

2626
The python-stix library is hosted on `PyPI
27-
<https://pypi.python.org/pypi/stix/>`_ and the most recent stable version can be
27+
<https://pypi.python.org/pypi/stix/>`_ and the most recent stable version can be
2828
installed with `pip <https://pypi.python.org/pypi/pip>`_:
2929

3030
::
@@ -60,13 +60,13 @@ Installation on Windows
6060
~~~~~~~~~~~~~~~~~~~~~~~
6161

6262
Download the Lxml wheel for your version of Python from
63-
http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml, then install it via "pip install
63+
http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml, then install it via "pip install
6464
<filename>.whl". For example, to install it on 64-bit Windows running Python 2.7:
6565

6666
::
6767

68-
> pip install lxml-3.6.1-cp27-cp27m-win_amd64.whl
69-
> pip install stix
68+
$ pip install lxml-3.6.1-cp27-cp27m-win_amd64.whl
69+
$ pip install stix
7070

7171
Versioning
7272
----------

setup.cfg

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1+
[bumpversion]
2+
current_version = 1.2.0.7
3+
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+).(?P<revision>\d+)
4+
serialize = {major}.{minor}.{patch}.{revision}
5+
commit = True
6+
tag = True
7+
8+
[bumpversion:file:stix/version.py]
9+
10+
[bumpversion:file:docs/index.rst]
11+
112
[bdist_wheel]
213
universal = True

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# Copyright (c) 2017, The MITRE Corporation. All rights reserved.
44
# See LICENSE.txt for complete terms.
55

6+
from io import open # Allow `encoding` kwarg on Python 2.7
67
from os.path import abspath, dirname, join
78

89

@@ -22,7 +23,7 @@ def get_version():
2223

2324

2425
def get_long_description():
25-
with open('README.rst') as f:
26+
with open('README.rst', encoding='utf-8') as f:
2627
return f.read()
2728

2829

@@ -45,7 +46,6 @@ def get_long_description():
4546
url="http://stix.mitre.org",
4647
packages=find_packages(),
4748
install_requires=install_requires,
48-
license="BSD",
4949
classifiers=[
5050
'Development Status :: 5 - Production/Stable',
5151
'Intended Audience :: Developers',

tox.ini

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tox]
2-
envlist = py27, py34, py35, py36, py37, lxml23, docs, no-maec
2+
envlist = py27, py34, py35, py36, py37, lxml23, docs, no-maec, packaging
33

44
[testenv]
55
commands =
@@ -33,10 +33,16 @@ deps =
3333
commands =
3434
sphinx-build -W -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html
3535

36+
[testenv:packaging]
37+
deps =
38+
readme_renderer
39+
commands =
40+
python setup.py check -r -s
41+
3642
[travis]
3743
python =
38-
2.7: py27, docs, lxml23, no-maec
44+
2.7: py27, docs, lxml23, no-maec, packaging
3945
3.4: py34, no-maec
4046
3.5: py35, no-maec
41-
3.6: py36, no-maec
47+
3.6: py36, no-maec, packaging
4248
3.7: py37, no-maec

0 commit comments

Comments
 (0)