[IMP] Making package

.bumpversion.cfg

@@ -0,0 +1,7 @@
+[bumpversion]
+current_version = 0.1.1
+commit = True
+tag = True
+
+[bumpversion:file:mqt/__about__.py]
+

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Odoo Community Association <[email protected]>
+
+Contributors
+------------
+
+None yet. Why not be the first?

CHANGES

@@ -0,0 +1,25 @@
+=========
+Changelog
+=========
+
+Here you can find the recent changes to mqt..
+
+.. changelog::
+    :version: dev
+    :released: Ongoing
+
+    .. change::
+        :tags:  docs
+
+        Updated CHANGES.
+
+.. changelog::
+    :version: 0.1.0
+    :released: 2017-10-26
+
+    .. change::
+        :tags: project
+
+        First release on PyPi.
+
+.. todo:: vim: set filetype=rst:

CONTRIBUTING.rst

@@ -0,0 +1,111 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given. 
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/oca/mqt/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+mqt could always use more documentation, whether as part of the 
+official mqt 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/oca/mqt/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `mqt` for local development.
+
+1. Fork the `mqt` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone [email protected]:your_name_here/mqt.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 mqt
+    $ cd mqt/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ flake8 mqt tests
+    $ python setup.py test
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv. 
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   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, and 3.3, and for PyPy. Check 
+   https://travis-ci.org/oca/mqt/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+	$ python -m unittest tests.test_mqt

MANIFEST.in

@@ -0,0 +1,9 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include CHANGES
+include TODO
+include LICENSE
+include README.rst
+include package_metadata.py
+include requirements.txt
+include SCRIPTS

Makefile

@@ -0,0 +1,54 @@
+.PHONY: clean-pyc clean-build docs
+
+help:
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "testall - run tests on every Python version with tox"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release"
+	@echo "sdist - package"
+
+clean: clean-build clean-pyc
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+lint:
+	flake8 mqt tests
+
+test:
+	python setup.py test
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source mqt setup.py test
+	coverage report -m
+	coverage html
+	open htmlcov/index.html
+
+docs:
+	rm -f docs/mqt.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ mqt
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	open docs/_build/html/index.html
+
+release: clean
+	python setup.py sdist upload
+
+sdist: clean
+	python setup.py sdist
+	ls -l dist

README.md → README.rst

@@ -32,13 +32,15 @@ Multiple values for environment variable VERSION
 You can use branch or pull request into environment variable VERSION:
 
 - Branch 10.0
+
 ```
-    VERSION="10.0" ODOO_REPO="odoo/odoo"
+VERSION="10.0" ODOO_REPO="odoo/odoo"
 ```
 
 - Pull request odoo/odoo#143
+
 ```
-    VERSION="pull/143" ODOO_REPO="odoo/odoo"
+VERSION="pull/143" ODOO_REPO="odoo/odoo"
 ```
 
 Using custom branch inside odoo repository using ODOO_BRANCH
@@ -48,8 +50,9 @@ You can use the custom branch into the ODOO_REPO using the environment variable
 
 
 - Branch saas-17
+
 ```
-  ODOO_REPO="odoo/odoo" ODOO_BRANCH="saas-17"
+ODOO_REPO="odoo/odoo" ODOO_BRANCH="saas-17"
 ```
 
 Module unit tests
@@ -61,8 +64,9 @@ Activate it through the `UNIT_TEST` directive.
 An additional line should be added to the `env:` section,
 similar to this one:
 
-    - VERSION="8.0" UNIT_TEST="1"
-
+```
+VERSION="8.0" UNIT_TEST="1"
+```
 
 Coveralls/Codecov configuration file
 ------------------------------------
@@ -86,29 +90,29 @@ templates in order to speed up your CI pipeline.
 Just specify at will:
 `MQT_TEMPLATE_DB='mqt_odoo_template' MQT_TEST_DB='mqt_odoo_test'`.
 Give us feedback on you experiences, and if you could share findings
-from your use case, there might be some grateful people arround.
-
+from your use case, there might be some grateful people around.
 
 Isolated pylint+flake8 checks
 -----------------------------
 If you want to make a build exclusive for these checks, you can add a line
 on the `env:` section of the .travis.yml file with this content:
 
-    - VERSION="7.0" LINT_CHECK="1"
+```
+VERSION="7.0" LINT_CHECK="1"
+```
 
 You will get a faster answer about these questions and also a fast view over
 semaphore icons in Travis build view.
 
 To avoid making again these checks on other builds, you have to add
 LINT_CHECK="0" variable on the line:
 
-    - VERSION="7.0" ODOO_REPO="odoo/odoo" LINT_CHECK="0"
-
+```
+VERSION="7.0" ODOO_REPO="odoo/odoo" LINT_CHECK="0"
+```
 
 Disable test
 ------------
 If you want to make a build without tests, you can use the following directive:
-`TEST_ENABLE="0"`
-
-You will simply get the databases with packages installed, 
-but whithout running any tests.
+`TEST_ENABLE="0"` You will simply get the databases with packages installed,
+but without running any tests.

SCRIPTS

@@ -0,0 +1,2 @@
+[console_scripts]
+mqt=mqt.cli:cli

TODO

@@ -0,0 +1,16 @@
+====
+TODO
+====
+
+dev
+---
+
+- Write the tests
+- Write the project
+- Release
+- Optimize for clarity
+- Release
+- Optimize for speed
+- Release
+
+.. todo:: vim: set filetype=rst: