Page MenuHomeFreeBSD

Port for annotator-store
Needs RevisionPublic

Authored by wblock on Jul 26 2014, 3:25 AM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 23 2023, 12:34 AM
Unknown Object (File)
Nov 6 2023, 9:28 PM
Unknown Object (File)
Nov 1 2023, 2:31 PM
Unknown Object (File)
Oct 5 2023, 8:28 PM
Unknown Object (File)
Sep 30 2023, 2:29 PM
Unknown Object (File)
Sep 21 2023, 10:29 PM
Unknown Object (File)
Sep 11 2023, 1:42 PM
Unknown Object (File)
Aug 7 2023, 8:09 AM
Subscribers

Details

Reviewers
koobs

Diff Detail

Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

wblock retitled this revision from to Port for annotator.js.
wblock updated this object.
wblock edited the test plan for this revision. (Show Details)
wblock added a reviewer: koobs.
wblock added inline comments.
www/annotator-store/Makefile
14

py-itsdangerous has a JSON option that defaults to off, but it might be needed for this port. No idea how to check for that.

koobs requested changes to this revision.Jul 26 2014, 3:30 AM
koobs edited edge metadata.
koobs added inline comments.
www/annotator-store/Makefile
4

Upstream name is 'annotator' [1]

https://pypi.python.org/pypi/annotator/0.11.2

6

www python

7

Remove this, use USE_GITHUB=yes and GH_* variables instead, which to DISTNAME,WRKSRC, etc for you (See: bsd.sites.mk)

8

Not needed with USE_GITHUB/GH-*, see previous comment

16

Match the versioning in setup.py for all RUN_DEPENDS entries as closely as possible unless they cannot be matched given the limitations in our make syntax.

Of course, if a version requirement is ==, use >= instead

https://github.com/openannotation/annotator-store/blob/master/setup.py#L4

21

Not needed with USE_GITHUB and GH-* variables, See earlier comment

www/annotator-store/pkg-descr
5

Strip trailing slashes

This revision now requires changes to proceed.Jul 26 2014, 3:30 AM
www/annotator-store/Makefile
22

I note [1] that Python 3.x support is experimental (and perhaps not in the release distribution?). Unless tested and functional, set USE_PYTHON=-2.7

www/annotator-store/Makefile
14

The test suite is the first place id start to evaluate that question

www/annotator-store/pkg-descr
4

Missing WWW: for both entries?

wblock retitled this revision from Port for annotator.js to Port for annotator-store.
wblock edited edge metadata.

Update. Note that this really is a port for annotator-store, not annotator.js, so I think the portname is correct.

koobs requested changes to this revision.Apr 11 2015, 11:33 AM
koobs edited edge metadata.
koobs added inline comments.
www/annotator-store/Makefile
3

Our target state for all Python ports is that PORTNAME matches upstream PyPi name if it exists there. Exceptional cases may warrant otherwise, but this is not one of them.

Among other reasons, Python developers and users expect to be able to "pip install <pypi-name>" and it is there default expectation to search under these names in packages/ports as well. Process being:

  1. Find or referred to a great package on pypi I want
  2. Check ports/packages for that name

Bonus: It helps FreeBSD rank well for searches containing those terms

4

annotator(-store) is now 0.14.1. Update to suit

13–14

Lowercase no?

Also, Flask is optional since Annotator (this port) 0.12.0

15

I don't think installing ElasticSearch server (and thus Java) should be done unconditionally, unless every annotator-store node must have a local elasticsearch instance locally. ES servers can be remote, and can be (and often are) clustered across multiple nodes.

If not, something like:

OPTIONS_DEFINE=ELASTICSEARCH
ELASTICSEARCH_DESC=Include ElasticSearch Server on this host

This is where Debians Suggests/Recommends offers some nice granularity to optional components.

22

GH_COMMIT is now deprecated (See Mk/bsd.sites.mk)

Alternatively, use MASTER_SITES=CHEESESHOP and remove GITHUB/GH_* bits

24

USE_PYTHON has been replaced by USES=python[:versionspec] (See Uses/python.mk for more)

Also, annotator-store (this port) apparently supports Python 3:

See: annotator-store README

25–26

This is now:

USE_PYTHON= <feature>[,<feature]

Again see Uses/python.mk for more detail

www/annotator-store/pkg-descr
3

Strip trailing slash

This revision now requires changes to proceed.Apr 11 2015, 11:33 AM

I'm reconsidering whether this is the best storage plugin to port. ElasticSearch appears to be a big Java blob, and not necessary for small implementations.

Here is a list of alternates. Some are very nice, but mostly I would like one that is low on overhead, open licensed, and easy to port. Maybe the CouchDB one.

https://github.com/openannotation/annotator/wiki#backend-stores

The nodejs one is very nice, and has a live demo: http://ec2-54-191-181-65.us-west-2.compute.amazonaws.com:3060/annotation/mary/demo.html