Skip to content

Commit f3f9bd6

Browse files
brifordwyliebrifordwylie
committed
initial project harness
1 parent bbc654d commit f3f9bd6

24 files changed

Lines changed: 1156 additions & 2 deletions

‎.travis.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Config file for automatic testing at travis-ci.org
2+
3+
language: python
4+
5+
python:
6+
- "3.3"
7+
- "2.7"
8+
- "2.6"
9+
- "pypy"
10+
11+
# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
12+
install:
13+
- pip install -r requirements.txt
14+
15+
# command to run tests, e.g. python setup.py test
16+
script:
17+
- py.test

‎AUTHORS.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Brian Wylie <brian.wylie@kitware.com>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

‎CONTRIBUTING.rst‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
You can contribute in many ways:
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/kitware/broutils/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version.
21+
* Any details about your local setup that might be helpful in troubleshooting.
22+
* Detailed steps to reproduce the bug.
23+
24+
Fix Bugs
25+
~~~~~~~~
26+
27+
Look through the GitHub issues for bugs. Anything tagged with "bug"
28+
is open to whoever wants to implement it.
29+
30+
Implement Features
31+
~~~~~~~~~~~~~~~~~~
32+
33+
Look through the GitHub issues for features. Anything tagged with "feature"
34+
is open to whoever wants to implement it.
35+
36+
Write Documentation
37+
~~~~~~~~~~~~~~~~~~~
38+
39+
Bro Python Utilities could always use more documentation, whether as part of the
40+
official Bro Python Utilities docs, in docstrings, or even on the web in blog posts,
41+
articles, and such.
42+
43+
Submit Feedback
44+
~~~~~~~~~~~~~~~
45+
46+
The best way to send feedback is to file an issue at https://github.com/kitware/broutils/issues.
47+
48+
If you are proposing a feature:
49+
50+
* Explain in detail how it would work.
51+
* Keep the scope as narrow as possible, to make it easier to implement.
52+
* Remember that this is a volunteer-driven project, and that contributions
53+
are welcome :)
54+
55+
Get Started!
56+
------------
57+
58+
Ready to contribute? Here's how to set up `broutils` for
59+
local development.
60+
61+
1. Fork_ the `broutils` repo on GitHub.
62+
2. Clone your fork locally::
63+
64+
$ git clone git@github.com:your_name_here/broutils.git
65+
66+
3. Create a branch for local development::
67+
68+
$ git checkout -b name-of-your-bugfix-or-feature
69+
70+
Now you can make your changes locally.
71+
72+
4. When you're done making changes, check that your changes pass style and unit
73+
tests, including testing other Python versions with tox::
74+
75+
$ tox
76+
77+
To get tox, just pip install it.
78+
79+
5. Commit your changes and push your branch to GitHub::
80+
81+
$ git add .
82+
$ git commit -m "Your detailed description of your changes."
83+
$ git push origin name-of-your-bugfix-or-feature
84+
85+
6. Submit a pull request through the GitHub website.
86+
87+
.. _Fork: https://github.com/kitware/broutils/fork
88+
89+
Pull Request Guidelines
90+
-----------------------
91+
92+
Before you submit a pull request, check that it meets these guidelines:
93+
94+
1. The pull request should include tests.
95+
2. If the pull request adds functionality, the docs should be updated. Put
96+
your new functionality into a function with a docstring, and add the
97+
feature to the list in README.rst.
98+
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy.
99+
Check https://travis-ci.org/kitware/broutils
100+
under pull requests for active pull requests or run the ``tox`` command and
101+
make sure that the tests pass for all supported Python versions.
102+
103+
104+
Tips
105+
----
106+
107+
To run a subset of tests::
108+
109+
$ py.test test/test_broutils.py

‎HISTORY.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. :changelog:
2+
3+
History
4+
-------
5+
6+
0.1.0 (2016-03-22)
7+
++++++++++++++++++
8+
9+
* First release on PyPI.

‎MANIFEST.in‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include HISTORY.rst
4+
include LICENSE
5+
include README.rst

‎Makefile‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.PHONY: help clean clean-pyc clean-build list test test-all coverage docs release sdist
2+
3+
help:
4+
@echo "clean-build - remove build artifacts"
5+
@echo "clean-pyc - remove Python file artifacts"
6+
@echo "lint - check style with flake8"
7+
@echo "test - run tests quickly with the default Python"
8+
@echo "test-all - run tests on every Python version with tox"
9+
@echo "coverage - check code coverage quickly with the default Python"
10+
@echo "docs - generate Sphinx HTML documentation, including API docs"
11+
@echo "release - package and upload a release"
12+
@echo "sdist - package"
13+
14+
clean: clean-build clean-pyc
15+
16+
clean-build:
17+
rm -fr build/
18+
rm -fr dist/
19+
rm -fr *.egg-info
20+
21+
clean-pyc:
22+
find . -name '*.pyc' -exec rm -f {} +
23+
find . -name '*.pyo' -exec rm -f {} +
24+
find . -name '*~' -exec rm -f {} +
25+
26+
lint:
27+
flake8 broutils test
28+
29+
test:
30+
py.test
31+
32+
test-all:
33+
tox
34+
35+
coverage:
36+
coverage run --source broutils setup.py test
37+
coverage report -m
38+
coverage html
39+
open htmlcov/index.html
40+
41+
docs:
42+
rm -f docs/broutils.rst
43+
rm -f docs/modules.rst
44+
sphinx-apidoc -o docs/ broutils
45+
$(MAKE) -C docs clean
46+
$(MAKE) -C docs html
47+
open docs/_build/html/index.html
48+
49+
release: clean
50+
python setup.py sdist upload
51+
python setup.py bdist_wheel upload
52+
53+
sdist: clean
54+
python setup.py sdist
55+
python setup.py bdist_wheel upload
56+
ls -l dist

‎README.md‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎README.rst‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
========
2+
BroUtils
3+
========
4+
5+
**Python Utilities for Bro IDS:** `Read the
6+
Docs <http://broutils.rtfd.org>`__
7+
8+
|travis| |Coverage Status| |landscape| |version| |downloads|
9+
|wheel| |supported-versions| |supported-implementations| |license|
10+
11+
Features
12+
--------
13+
14+
* TODO
15+
16+
Install
17+
-------
18+
19+
::
20+
21+
$ pip install broutils
22+
23+
Documentation
24+
-------------
25+
26+
`broutils.readthedocs.org <https://broutils.readthedocs.org/>`__
27+
28+
About
29+
-----
30+
31+
32+
Example
33+
-------
34+
35+
36+
37+
38+
.. |travis| image:: https://img.shields.io/travis/kitware/broutils.svg
39+
:target: https://travis-ci.org/kitware/broutils
40+
.. |Coverage Status| image:: https://coveralls.io/repos/kitware/broutils/badge.svg?branch=HEAD
41+
:target: https://coveralls.io/r/kitware/broutils
42+
.. |landscape| image:: https://landscape.io/github/kitware/broutils/master/landscape.svg?style=flat
43+
:target: https://landscape.io/github/kitware/broutils/master
44+
.. |version| image:: https://img.shields.io/pypi/v/broutils.svg
45+
:target: https://pypi.python.org/pypi/broutils
46+
.. |downloads| image:: https://img.shields.io/pypi/dm/broutils.svg
47+
:target: https://pypi.python.org/pypi/broutils
48+
.. |wheel| image:: https://img.shields.io/pypi/wheel/broutils.svg
49+
:target: https://pypi.python.org/pypi/broutils
50+
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/broutils.svg
51+
:target: https://pypi.python.org/pypi/broutils
52+
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/broutils.svg
53+
:target: https://pypi.python.org/pypi/broutils
54+
.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-green.svg
55+
:target: http://choosealicense.com/licenses/apache-2.0

‎broutils/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
__author__ = 'Brian Wylie'
2+
__email__ = 'brian.wylie@kitware.com'
3+
__version__ = '0.1.0'

‎broutils/broutils.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)