Initial Release - foreach API #1

lasley · 2017-10-12T16:25:24Z

This is the initial release of the OCA-decorators package. It currently contains the foreach API.

lasley · 2017-10-12T16:27:39Z

.travis.yml

+    - RELEASE="0.1.0"
+    - PROJECT="oca-decorators"
+    - ODOO="10.0"
+    - secure: "N4FxLhiQYktu5TUym48Kf5GoCeqSn/iNZT4rK9ktN18gOazkj5P9tPz33p8vde06f+yDTw6ETOZaTHUv7oGwlpc58ToMFey+XxlSyCeGoNVGi7uojs5DqF48lfKZbbTjCiiyj/6Ub7FH3IzcizbN+9WzJ6JB7v8U6eX8LwAW7YKPhdPctFM7rFZiLQp/r8lf0xN5WpMhufg3xloBJkS+iuQopULK7Il2g6Ag8Qo54IUFJzWQbZYKN8RMy0Ek41rgx88sKrTp9TDo0RBircy7f/6WH/CERTGRYtHCQDF0RToYaH9qiRiZ3w6vaxepbIicJCMCMvOQaSJ8IibIwBstwpkM0P2dHVP9WQiwxGgYMeCxS2MNkacQLAfxGXcMiRlfliq7SQpBYp7t3uEpby1l1UqDyTb+5aNUF8Y5CFx1hbbr2r++U8vLRxxvQRAzfl48Dy1jWw5N1hug/1VbGU7XuWPHiZd2WRngs2r7kUJVig9b3jQoi87kIr0V8FHjRALfsfo/swPD5mwI00qQ2eOySTKC8SSCToudByub1DYAPvuLn0JDGH1z7pDIe4rucZSSztvkiCOtlndYcm2hbyNLLVUN5Fn/GCmNZp2yer/h5Myn2kw3bMjdDLkVcgK5Ku2/eb5IMUWrjL4MbdczsUeqfNRK9oy5HEAAh+4sfre5Dw0="


Generate a token for the OCA PyPi account

Also Travis needs secure variable for a Github token to post gh-pages

bealdav

No test, appreciate feature

yajo

❤️

yajo · 2017-10-17T08:12:56Z

README.rst

+   :target: https://codeclimate.com/github/OCA/oca-decorators
+.. |License MIT| image:: https://img.shields.io/github/license/OCA/oca-decorators.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: License: MIT


yajo · 2017-10-17T08:26:17Z

setup.py

+
+from os import environ, path
+
+PROJECT = 'oca-decorators'


I'd love it if we change the name of this, now that it's not yet too late. Calling it oca-decorators seems to be too narrowing for possible helpers that are not decorators (context managers, test classes, data loaders, mock helpers, etc.).

I'd just call this ocalib (or ocahelpers, odoohelpers, oca or similar). The code would result into:

from ocalib import decorators ... @decorators.foreach() def what(self): ...

We could even decide to provide decorators in the main namespace, although this is not so important:

import ocalib @ocalib.foreach() def lalala()...

+1 for wide name than only decorator

I'm indifferent on the naming. It was done this way so that we could make micro libraries and avoid a monolithic package. The conversation started here. CC @lmignon

yajo · 2017-10-17T08:27:27Z

setup.py

+version = environ.get('RELEASE') or environ.get('VERSION') or '0.0.1'
+
+if environ.get('TRAVIS_BUILD_NUMBER'):
+    version += 'b%s' % environ.get('TRAVIS_BUILD_NUMBER')


Please don't hardcode travis. I already hit it with MQT. It's better IMHO if you provide a vendorless variable and transform the travis one into that in .travis.yml.

I need something to guarantee an increasing build number. Open to ideas, but this is the one I have.

It's worth noting this works perfectly fine without Travis. It's required to push to PyPi with guaranteed versions. I've never actually been able to get tox to work, so this is what we have.

I'm pretty sure this logic can be removed if someone submits a PR implementing tox. I've spent way too much time trying to figure it out in the past, with zero luck, so I'm not willing to look again. Sorry, but I literally designed a whole build/test system because of my inherent inability to use tox.

@lasley The best way is to use setuptools_scmto manage the version. It's what we use for git-aggregator for exemple. acsone/git-aggregator@545a097#diff-2eeaed663bd0d25b7e608891384b7298
As you can see in the previous link, you can also use travis to deploy the lib each time you create a tag.

Thanks for the example @lmignon - much easier than Tox. Totally looks doable.

That deploy section in the Travis file - is that provided by setuptools_scm?

Oh wow nvm this is just a TravisCI feature. Well that's freaking cool

yajo · 2017-10-17T08:28:02Z

setup.py

+    'Topic :: Software Development :: Libraries :: Python Modules',
+]
+
+version = environ.get('RELEASE') or environ.get('VERSION') or '0.0.1'


Shouldn't the package have a __version__ attribute to read here? 🤔

Got me dude, I made this all up. I put the version in the Travis file. Where should I be putting it?

yajo · 2017-10-17T08:28:50Z

setup.py

+        packages=find_packages(exclude=('tests')),
+        cmdclass={'test': Tests},
+        tests_require=[
+            'mock',


This should only be required in Python 2... in case it were used, but it isn't.

lmignon · 2017-10-18T10:05:39Z

oca/__init__.py

+# -*- coding: utf-8 -*-
+# Copyright 2016 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+


@lasley This file must only contain __path__ = __import__('pkgutil').extend_path(__path__, __name__) to keep oca as a reusable namespace package.
https://packaging.python.org/guides/packaging-namespace-packages/#pkgutil-style-namespace-packages

I think the complexity of having the package split doesn't pay. It's just easier to have all in one place, this shouldn't grow up so much as to be unmaintainable. Just a collection of helpers...

@yajo I think we must keep the possibility to release others python packages under the oca namespace. (ie: utilities to use in our dev/release process, ????). There is nothing complex here.

lmignon · 2017-10-18T10:28:47Z

setup.py

+    'Programming Language :: Python :: 3.4',
+    'Programming Language :: Python :: 3.5',
+    'Programming Language :: Python :: 3.6',
+    'Topic :: Software Development :: Libraries :: Python Modules',


@lasley You can also add Framework :: Odoo into the list. It's now an official classifier https://pypi.python.org/pypi?%3Aaction=list_classifiers

lmignon · 2017-10-18T10:32:45Z

oca/decorators/__init__.py

+from .foreach import foreach
+
+
+__all__ = [


@lasley You can leave this file empty.

This is required in order to make the foreach method inside of the foreach file directly importable.

Otherwise usage is:

from oca.decorators.foreach import foreach

instead of

from oca.decorators import foreach

Do you have a better way to solve this?

Do we really want one file per decorator? 😲

I generally prefer deeper file hierarchies with smaller files. I've found that if I don't do this type of thing from the get-go I end up in a situation where the files are thousands of lines deep, I spend a bunch of time trying to categorize things, then just lose stuff anyways.

I'm open to consideration here though. You would prefer to categorize/group somehow?

@lasley IMO Your way of organizing your code is safe.

lmignon · 2017-10-18T10:33:44Z

setup.py

+    pass
+
+
+class Tests(Command):


What's the purpose of this class?

It discovers tests to run, then runs them. I prefer to have the isolated class, because our internal CI can inject XmlTestRunner for parse by JUnit

@lasley IMO we must keep setup.py the must simple as possible and only put into this file the information required to package and setup the code. Moreover, we can simplify the content of .travis.yml to only use standard python tools. I'll propose you a PR.

@lasley I've simplified the code to run tests with standard tools. LasLabs#1. You can see the result in #3 .
IMO the code is cleaner, easier to read and maintain.

sbidoul · 2017-10-19T08:12:11Z

requirements.txt

@@ -0,0 +1 @@
+decorator==4.0.10


Since this is a library, do not pin version.

sbidoul · 2017-10-19T08:13:06Z

setup.py

+        setup_requires=[
+            'setuptools_scm',
+        ],
+        install_requires=install_requires,


So install_requires=['decorator>=4'] should be sufficient.

lmignon · 2017-10-19T17:27:11Z

setup.py

+
+
+install_requires = []
+if path.exists('requirements.txt'):


@lasley you should remove the requirements.txt file and declare you dependencies into install_requires

lmignon · 2017-10-19T17:30:41Z

setup.py

+        setup_requires=[
+            'setuptools_scm',
+        ],
+        install_requires=install_requires,


@lasley install_requires=['decorator'] If you need a minimal version: install_requires=['decorator>=4.0']

lasley · 2017-10-24T18:44:53Z

Oops sorry I forgot about this one. Requirements.txt removed, decorator lib unfrozen (I don't know a specific version so it's blank), and added to install_requires

* Travis * Coveragerc * Gitignore * License * ReadMe * requirements, include Odoo * setup [ADD] Foreach API (#1) * [ADD] Foreach API * Add foreach API * Change license to LGPL (odoo dependency) * Add return value assertion to foreach api * Fix docblocks and make thing super efficient! * Dumb it down! * Fix docblock to have call * Rename api to helpers [FIX] CodeClimate Badge [FIX] Update pip instructions, fixes OCA#3 [IMP] Update Travis, Setup, ReadMe * Add PyPi to Travis * Add version definitions to setup * Add current badge structure to ReadMe [IMP] Prep for OCA release * Add Python 3 support * Change author from LasLabs to OCA * Update repos * Move `helpers` package to `decorators` Switch versioning, license Namespace/package updates, add Odoo framework Fix docblock for Tests Fix travis Revert decorators init

* Simplify tests * Add codeclimate * Support Py36 * Remove Py34 from classifiers into setup.py

lasley · 2017-10-24T18:55:18Z

I squashed up too so we can merge once done. The only two changes not reviewed in this PR are
f5edb1f & df1dab4, so it worked cleanly I think

lmignon

@lasley LGTM. (Code Review Only)

yajo · 2017-10-25T11:40:16Z

Some of the pip pros please hit the button 😊

lasley · 2017-10-25T14:46:22Z

Now time to see if this actually pushes to PyPi. I need to make a tag yeah?

lmignon · 2017-10-25T14:48:46Z

@lasley yes

lasley · 2017-10-25T15:36:54Z

Damn it seems I did the Travis file slightly wrong. I made the fix on master and retagged. We're now on PyPi!!! https://pypi.python.org/pypi?:action=display&name=oca-decorators&version=0.0.1

lasley · 2017-10-25T15:57:39Z

Hmmm but what about documentation? My build system did that as well, but it's blank and I don't see Travis attempting anything.

lmignon · 2017-10-26T08:00:46Z

@lasley IMO You must modify .travis.yml to gen and publish the documentation. You should find plenty examples on the net on how to do it...

lasley · 2017-10-26T15:11:10Z

But I had documentation until Tox was added. I have never been able to get Travis to automatically compile my Sphinx docs using anything other than the build system that I created, which was removed in favor of a strategy I advised I knew nothing about and was not able to get to work.

lmignon · 2017-10-26T16:35:30Z

@lasley I'll experiment a simple way to do it on Alfodoo and come back with a PR on oca-decorators once it's done. I plan to use https://github.com/Syntaf/travis-sphinx/

lasley · 2017-10-26T16:42:01Z

This is one of those times I wish I kept better notes, I remember trying travis-sphinx and ultimately failing for a now forgotten reason. Maybe it'll help, this is what I ended up with in the custom build system:

Edit: Fixed the duplicated link & added sphinx config link

sbidoul · 2017-10-26T19:34:42Z

If I remember correctly, OCA/connector has a decent way to generate doc.

This was referenced Oct 12, 2017

[RFC] new api.groups decorator for function OCA/server-tools#944

Closed

python-OCA lib LasLabs/python-oca#5

Closed

lasley commented Oct 12, 2017

View reviewed changes

bealdav approved these changes Oct 12, 2017

View reviewed changes

yajo suggested changes Oct 17, 2017

View reviewed changes

lasley force-pushed the release/0.0.1 branch from 52a19e8 to b35faaf Compare October 18, 2017 00:11

yajo approved these changes Oct 18, 2017

View reviewed changes

lmignon reviewed Oct 18, 2017

View reviewed changes

lmignon suggested changes Oct 18, 2017

View reviewed changes

sbidoul reviewed Oct 19, 2017

View reviewed changes

lmignon reviewed Oct 19, 2017

View reviewed changes

lmignon suggested changes Oct 19, 2017

View reviewed changes

lasley and others added 3 commits October 24, 2017 11:54

Improve travis (#1)

f5edb1f

* Simplify tests * Add codeclimate * Support Py36 * Remove Py34 from classifiers into setup.py

Remove requirements.txt

df1dab4

lasley force-pushed the release/0.0.1 branch from e466c20 to df1dab4 Compare October 24, 2017 18:54

lmignon approved these changes Oct 25, 2017

View reviewed changes

lasley merged commit 496d4d2 into OCA:master Oct 25, 2017

lasley deleted the release/0.0.1 branch October 25, 2017 14:45

lasley mentioned this pull request Oct 31, 2017

Docs not working #5

Closed

		@@ -0,0 +1 @@
		decorator==4.0.10



		install_requires = []
		if path.exists('requirements.txt'):

Initial Release - foreach API #1

Initial Release - foreach API #1

Conversation

lasley commented Oct 12, 2017

Choose a reason for hiding this comment

bealdav left a comment

Choose a reason for hiding this comment

yajo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lasley Oct 17, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lasley Oct 19, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lasley commented Oct 24, 2017 • edited

lasley commented Oct 24, 2017 • edited

lmignon left a comment

Choose a reason for hiding this comment

yajo commented Oct 25, 2017

lasley commented Oct 25, 2017

lmignon commented Oct 25, 2017

lasley commented Oct 25, 2017

lasley commented Oct 25, 2017

lmignon commented Oct 26, 2017

lasley commented Oct 26, 2017

lmignon commented Oct 26, 2017

lasley commented Oct 26, 2017 • edited

sbidoul commented Oct 26, 2017

lasley Oct 17, 2017 •

edited

lasley Oct 19, 2017 •

edited

lasley commented Oct 24, 2017 •

edited

lasley commented Oct 24, 2017 •

edited

lasley commented Oct 26, 2017 •

edited