Skip to content

Commit

Permalink
.
Browse files Browse the repository at this point in the history
  • Loading branch information
yan-duarte committed Aug 31, 2017
1 parent 2bb636c commit 1fd932d
Show file tree
Hide file tree
Showing 21 changed files with 253 additions and 150 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* qStatistic version:
* qstatistic version:
* Python version:
* Operating System:

Expand Down
249 changes: 176 additions & 73 deletions .idea/workspace.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ deploy:
eFY0VE9GSnZkZUJrM1dyNFhMcFU1b3pNdDUyV3FKakdtY3czQzJhMGMwQktYMUVQczRYR3pUVVE9
true:
python: 3.6
repo: yan-duarte/qStatistic
repo: yan-duarte/qstatistic
tags: true
install: pip install -U tox-travis
language: python
Expand Down
24 changes: 12 additions & 12 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/yan-duarte/qStatistic/issues.
Report bugs at https://github.com/yan-duarte/qstatistic/issues.

If you are reporting a bug, please include:

Expand All @@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~

qStatistic could always use more documentation, whether as part of the
official qStatistic docs, in docstrings, or even on the web in blog posts,
qstatistic could always use more documentation, whether as part of the
official qstatistic docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/yan-duarte/qStatistic/issues.
The best way to send feedback is to file an issue at https://github.com/yan-duarte/qstatistic/issues.

If you are proposing a feature:

Expand All @@ -57,17 +57,17 @@ If you are proposing a feature:
Get Started!
------------

Ready to contribute? Here's how to set up `qStatistic` for local development.
Ready to contribute? Here's how to set up `qstatistic` for local development.

1. Fork the `qStatistic` repo on GitHub.
1. Fork the `qstatistic` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:yan-duarte/qStatistic.git
$ git clone git@github.com:yan-duarte/qstatistic.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv qStatistic
$ cd qStatistic/
$ mkvirtualenv qstatistic
$ cd qstatistic/
$ python setup.py develop

4. Create a branch for local development::
Expand All @@ -78,7 +78,7 @@ Ready to contribute? Here's how to set up `qStatistic` for local development.

5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::

$ flake8 qStatistic tests
$ flake8 qstatistic tests
$ python setup.py test or py.test
$ tox

Expand All @@ -102,7 +102,7 @@ Before you submit a pull request, check that it meets these guidelines:
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
https://travis-ci.org/yan-duarte/qStatistic/pull_requests
https://travis-ci.org/yan-duarte/qstatistic/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
Expand All @@ -111,4 +111,4 @@ Tips
To run a subset of tests::


$ python -m unittest tests.test_qStatistic
$ python -m unittest tests.test_qstatistic
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,25 @@ clean-test: ## remove test and coverage artifacts
rm -fr htmlcov/

lint: ## check style with flake8
flake8 qStatistic tests
flake8 qstatistic tests

test: ## run tests quickly with the default Python

python setup.py test

test-all: ## run tests on every Python version with tox
tox

coverage: ## check code coverage quickly with the default Python
coverage run --source qStatistic setup.py test
coverage run --source qstatistic setup.py test
coverage report -m
coverage html
$(BROWSER) htmlcov/index.html

docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/qStatistic.rst
rm -f docs/qstatistic.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ qStatistic
sphinx-apidoc -o docs/ qstatistic
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
Expand Down
20 changes: 10 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
==========
qStatistic
qstatistic
==========


.. image:: https://img.shields.io/pypi/v/qStatistic.svg
:target: https://pypi.python.org/pypi/qStatistic
.. image:: https://img.shields.io/pypi/v/qstatistic.svg
:target: https://pypi.python.org/pypi/qstatistic

.. image:: https://img.shields.io/travis/yan-duarte/qStatistic.svg
:target: https://travis-ci.org/yan-duarte/qStatistic
.. image:: https://img.shields.io/travis/yan-duarte/qstatistic.svg
:target: https://travis-ci.org/yan-duarte/qstatistic

.. image:: https://readthedocs.org/projects/qStatistic/badge/?version=latest
:target: https://qStatistic.readthedocs.io/en/latest/?badge=latest
.. image:: https://readthedocs.org/projects/qstatistic/badge/?version=latest
:target: https://qstatistic.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/yan-duarte/qStatistic/shield.svg
:target: https://pyup.io/repos/github/yan-duarte/qStatistic/
.. image:: https://pyup.io/repos/github/yan-duarte/qstatistic/shield.svg
:target: https://pyup.io/repos/github/yan-duarte/qstatistic/
:alt: Updates


Python Boilerplate contains all the boilerplate you need to create a Python package.


* Free software: GNU General Public License v3
* Documentation: https://qStatistic.readthedocs.io.
* Documentation: https://qstatistic.readthedocs.io.


Features
Expand Down
4 changes: 2 additions & 2 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/qStatistic.rst
/qStatistic.*.rst
/qstatistic.rst
/qstatistic.*.rst
/modules.rst
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/qStatistic.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/qstatistic.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/qStatistic.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/qstatistic.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/qStatistic"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/qStatistic"
@echo "# mkdir -p $$HOME/.local/share/devhelp/qstatistic"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/qstatistic"
@echo "# devhelp"

epub:
Expand Down
26 changes: 13 additions & 13 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# qStatistic documentation build configuration file, created by
# qstatistic documentation build configuration file, created by
# sphinx-quickstart on Tue Jul 9 22:26:36 2013.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -31,7 +31,7 @@
# version is used.
sys.path.insert(0, project_root)

import qStatistic
import qstatistic

# -- General configuration ---------------------------------------------

Expand All @@ -55,17 +55,17 @@
master_doc = 'index'

# General information about the project.
project = u'qStatistic'
project = u'qstatistic'
copyright = u"2017, Yan Anderson Siriano Duarte"

# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
# the built documents.
#
# The short X.Y version.
version = qStatistic.__version__
version = qstatistic.__version__
# The full version, including alpha/beta/rc tags.
release = qStatistic.__version__
release = qstatistic.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -188,7 +188,7 @@
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'qStatisticdoc'
htmlhelp_basename = 'qstatisticdoc'


# -- Options for LaTeX output ------------------------------------------
Expand All @@ -208,8 +208,8 @@
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'qStatistic.tex',
u'qStatistic Documentation',
('index', 'qstatistic.tex',
u'qstatistic Documentation',
u'Yan Anderson Siriano Duarte', 'manual'),
]

Expand Down Expand Up @@ -239,8 +239,8 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'qStatistic',
u'qStatistic Documentation',
('index', 'qstatistic',
u'qstatistic Documentation',
[u'Yan Anderson Siriano Duarte'], 1)
]

Expand All @@ -254,10 +254,10 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'qStatistic',
u'qStatistic Documentation',
('index', 'qstatistic',
u'qstatistic Documentation',
u'Yan Anderson Siriano Duarte',
'qStatistic',
'qstatistic',
'One line description of project.',
'Miscellaneous'),
]
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Welcome to qStatistic's documentation!
Welcome to qstatistic's documentation!
======================================

Contents:
Expand Down
16 changes: 8 additions & 8 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Installation
Stable release
--------------

To install qStatistic, run this command in your terminal:
To install qstatistic, run this command in your terminal:

.. code-block:: console
$ pip install qStatistic
$ pip install qstatistic
This is the preferred method to install qStatistic, as it will always install the most recent stable release.
This is the preferred method to install qstatistic, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
Expand All @@ -26,19 +26,19 @@ you through the process.
From sources
------------

The sources for qStatistic can be downloaded from the `Github repo`_.
The sources for qstatistic can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console
$ git clone git://github.com/yan-duarte/qStatistic
$ git clone git://github.com/yan-duarte/qstatistic
Or download the `tarball`_:

.. code-block:: console
$ curl -OL https://github.com/yan-duarte/qStatistic/tarball/master
$ curl -OL https://github.com/yan-duarte/qstatistic/tarball/master
Once you have a copy of the source, you can install it with:

Expand All @@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
$ python setup.py install
.. _Github repo: https://github.com/yan-duarte/qStatistic
.. _tarball: https://github.com/yan-duarte/qStatistic/tarball/master
.. _Github repo: https://github.com/yan-duarte/qstatistic
.. _tarball: https://github.com/yan-duarte/qstatistic/tarball/master
4 changes: 2 additions & 2 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\qStatistic.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\qstatistic.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\qStatistic.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\qstatistic.ghc
goto end
)

Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
Usage
=====

To use qStatistic in a project::
To use qstatistic in a project::

import qStatistic
import qstatistic
4 changes: 2 additions & 2 deletions qStatistic/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-

"""Top-level package for qStatistic."""
"""Top-level package for qstatistic."""

__author__ = """Yan Anderson Siriano Duarte"""
__email__ = 'yan_asd@hotmail.com'
__version__ = '__version__ = '0.2.0''
__version__ = '0.2.0'
2 changes: 1 addition & 1 deletion qStatistic/qStatistic.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def calc(self):
else:
temp = 1 + (1 - self.q)*self.x
if temp > 0:
return math.pow(temp,1/(1 - self.q))
return math.pow(temp, 1/(1 - self.q))
else:
return 0

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tag = True
search = version='{current_version}'
replace = version='{new_version}'

[bumpversion:file:qStatistic/__init__.py]
[bumpversion:file:qstatistic/__init__.py]
search = __version__ = '{current_version}'
replace = __version__ = '{new_version}'

Expand Down
12 changes: 6 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@
]

setup(
name='qStatistic',
version="version='0.2.0'",
description="qStatistic Library.",
name='qstatistic',
version='0.2.0',
description="qstatistic Library.",
long_description=readme + '\n\n' + history,
author="Yan Anderson Siriano Duarte",
author_email='yan_asd@hotmail.com',
url='https://github.com/yan-duarte/qStatistic',
packages=find_packages(include=['qStatistic']),
url='https://github.com/yan-duarte/qstatistic',
packages=find_packages(include=['qstatistic']),
include_package_data=True,
install_requires=requirements,
license="GNU General Public License v3",
zip_safe=False,
keywords='qStatistic',
keywords='qstatistic',
classifiers=[
'Development Status :: 2 - Pre-Alpha',
'Intended Audience :: Developers',
Expand Down

0 comments on commit 1fd932d

Please sign in to comment.