Skip to content

Commit 492e859

Browse files
augu5teaugu5te
committed
Added project skeleton
0 parents  commit 492e859

25 files changed

+1350
-0
lines changed

‎AUTHORS.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Olivier Richard <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

‎CHANGES.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. :changelog:
2+
3+
0.1.0 changelog
4+
============================================
5+
6+
Version 0.1.0.dev0
7+
------------------
8+
9+
**unreleased**
10+
11+
- First release on PyPI.

‎CONTRIBUTING.rst

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
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/oar-team/evalys/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+
Evalys could always use more documentation, whether as part of the
40+
official Evalys 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/oar-team/evalys/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 `evalys` for local development.
59+
60+
1. Fork the `evalys` repo on GitHub.
61+
2. Clone your fork locally::
62+
63+
$ git clone [email protected]:your_name_here/evalys.git
64+
65+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
66+
67+
$ mkvirtualenv evalys
68+
$ cd evalys/
69+
$ make init
70+
71+
4. Create a branch for local development::
72+
73+
$ git checkout -b name-of-your-bugfix-or-feature
74+
75+
Now you can make your changes locally.
76+
77+
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
78+
79+
$ flake8 evalys tests
80+
$ py.test
81+
$ tox
82+
83+
To get flake8 and tox, just pip install them into your virtualenv.
84+
85+
6. Commit your changes and push your branch to GitHub::
86+
87+
$ git add .
88+
$ git commit -m "Your detailed description of your changes."
89+
$ git push origin name-of-your-bugfix-or-feature
90+
91+
7. Submit a pull request through the GitHub website.
92+
93+
Pull Request Guidelines
94+
-----------------------
95+
96+
Before you submit a pull request, check that it meets these guidelines:
97+
98+
1. The pull request should include tests.
99+
2. If the pull request adds functionality, the docs should be updated. Put
100+
your new functionality into a function with a docstring, and add the
101+
feature to the list in README.rst.
102+
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check
103+
https://travis-ci.org/oar-team/evalys/pull_requests
104+
and make sure that the tests pass for all supported Python versions.
105+
106+
Tips
107+
----
108+
109+
To run a subset of tests::
110+
111+
$ py.test tests/test_evalys

‎LICENSE

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Copyright (c) 2015, Olivier Richard and contributors.
2+
See AUTHORS for more details.
3+
4+
Some rights reserved.
5+
6+
Redistribution and use in source and binary forms of the software as well
7+
as documentation, with or without modification, are permitted provided
8+
that the following conditions are met:
9+
10+
* Redistributions of source code must retain the above copyright
11+
notice, this list of conditions and the following disclaimer.
12+
13+
* Redistributions in binary form must reproduce the above
14+
copyright notice, this list of conditions and the following
15+
disclaimer in the documentation and/or other materials provided
16+
with the distribution.
17+
18+
* The names of the contributors may not be used to endorse or
19+
promote products derived from this software without specific
20+
prior written permission.
21+
22+
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
23+
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
24+
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
26+
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28+
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30+
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32+
SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
33+
DAMAGE.

‎MANIFEST.in

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include CHANGES.rst
4+
include LICENSE
5+
include README.rst
6+
7+
recursive-include tests *
8+
recursive-exclude * __pycache__
9+
recursive-exclude * *.py[co]
10+
11+
recursive-include docs *.rst conf.py Makefile make.bat

‎Makefile

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
SHELL := /bin/bash
2+
3+
# these files should pass flakes8
4+
FLAKE8_WHITELIST=$(shell find . -name "*.py" \
5+
! -path "./docs/*" ! -path "./.tox/*" \
6+
! -path "./env/*" ! -path "./venv/*" \
7+
! -path "**/compat.py")
8+
9+
open := $(shell { which xdg-open || which open; } 2>/dev/null)
10+
11+
.PHONY: clean-pyc clean-build docs clean
12+
13+
14+
help: ## This help dialog.
15+
@IFS=$$'\n' ; \
16+
help_lines=(`fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##/:/'`); \
17+
printf "%-15s %s\n" "target" "help" ; \
18+
printf "%-15s %s\n" "------" "----" ; \
19+
for help_line in $${help_lines[@]}; do \
20+
IFS=$$':' ; \
21+
help_split=($$help_line) ; \
22+
help_command=`echo $${help_split[0]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \
23+
help_info=`echo $${help_split[2]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \
24+
printf '\033[36m'; \
25+
printf "%-15s %s" $$help_command ; \
26+
printf '\033[0m'; \
27+
printf "%s\n" $$help_info; \
28+
done
29+
30+
31+
init: ## Install the project in development mode (using virtualenv is highly recommended)
32+
pip install -e .
33+
pip install -U setuptools pip
34+
pip install sphinx tox ipdb jedi pytest pytest-cov flake8 wheel bumpversion httpie
35+
36+
clean: clean-build clean-pyc clean-test ## Remove all build, test, coverage and Python artifacts
37+
38+
clean-build: ## Remove build artifacts
39+
rm -fr build/
40+
rm -fr dist/
41+
rm -fr .eggs/
42+
find . -name '*.egg-info' -exec rm -fr {} +
43+
find . -name '*.egg' -exec rm -f {} +
44+
45+
clean-pyc: ## Remove Python file artifacts
46+
find . -name '*.pyc' -exec rm -f {} +
47+
find . -name '*.pyo' -exec rm -f {} +
48+
find . -name '*~' -exec rm -f {} +
49+
find . -name '__pycache__' -exec rm -fr {} +
50+
51+
clean-test: ## Eemove test and coverage artifacts
52+
rm -fr .tox/
53+
rm -f .coverage
54+
rm -fr htmlcov/
55+
56+
test: ## Run tests quickly with the default Python
57+
py.test --verbose
58+
59+
testall: ## Run tests on every Python version with tox
60+
tox
61+
62+
ci: ## Run all tests and get junitxml report for CI (Travis, Jenkins...)
63+
py.test --junitxml=junit.xml
64+
65+
coverage: ## Check code coverage quickly with the default Python
66+
py.test --verbose --cov-report term --cov-report html --cov=evalys || true
67+
$(open) htmlcov/index.html
68+
69+
lint: ## Check style with flake8
70+
flake8 $(FLAKE8_WHITELIST)
71+
72+
docs: ## Generate Sphinx HTML documentation, including API docs
73+
$(MAKE) -C docs clean
74+
$(MAKE) -C docs html
75+
$(open) docs/_build/html/index.html
76+
77+
dist: clean ## Package
78+
python setup.py sdist
79+
python setup.py bdist_wheel
80+
ls -l dist
81+
82+
release: clean ## Package and upload a release
83+
python setup.py register
84+
python setup.py sdist upload
85+
python setup.py bdist_wheel upload
86+
87+
bumpversion: ## Bump the release version
88+
@python scripts/bumpversion.py release
89+
90+
newversion: ## Set the new development version
91+
@python scripts/bumpversion.py newversion $(filter-out $@,$(MAKECMDGOALS))
92+
93+
%:
94+
@:

‎README.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
===============================
2+
Evalys
3+
===============================
4+
5+
.. image:: https://img.shields.io/travis/oar-team/evalys.svg
6+
:target: https://travis-ci.org/oar-team/evalys
7+
8+
.. image:: https://img.shields.io/pypi/v/evalys.svg
9+
:target: https://pypi.python.org/pypi/evalys
10+
11+
12+
"Infrastructure Performance Evaluation Toolkit"
13+
14+
* Free software: BSD license
15+
* Documentation: https://evalys.readthedocs.org.
16+
17+
Features
18+
--------
19+
20+
* TODO

0 commit comments

Comments
 (0)