Bug 219823 - [NEW PORT] databases/pysispy: Client library for interacting with the SIS RESTful API
Summary: [NEW PORT] databases/pysispy: Client library for interacting with the SIS RES...
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Steve Wills
URL:
Keywords: easy, feature
Depends on:
Blocks:
 
Reported: 2017-06-06 14:31 UTC by Rick Miller
Modified: 2017-07-14 08:33 UTC (History)
4 users (show)

See Also:
koobs: maintainer-feedback+


Attachments
Add databases/sispy to Ports (2.34 KB, patch)
2017-06-06 14:31 UTC, Rick Miller
no flags Details | Diff
Diff to add py-sis-python to FreeBSD Ports (2.46 KB, patch)
2017-06-07 17:00 UTC, Rick Miller
no flags Details | Diff
Add databases/py-sispy to Ports (2.49 KB, patch)
2017-06-08 12:21 UTC, Rick Miller
no flags Details | Diff
Add databases/py-sispy to Ports (2.42 KB, patch)
2017-06-08 13:12 UTC, Rick Miller
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Rick Miller 2017-06-06 14:31:40 UTC
Created attachment 183264 [details]
Add databases/sispy to Ports

sispy is a Python client library for interacting with the SIS RESTful API
Comment 1 Kubilay Kocak freebsd_committer freebsd_triage 2017-06-06 14:44:32 UTC
Thank you for your contribution Rick.

Initial review items:

* Port directory should be named py-sispy
* python should be added to CATEGORIES (python is a virtual category)
* Use USE_GITHUB and GH_* variables to get the GitHub sources. For details see: https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/book.html#makefile-master_sites-github-description

MASTER_SITES and WRKSRC shouldn't be necessary when using the above variables. You may need to use DISTVERSIONPREFIX=foo if the GitHub tag for the version you want has a 'foo' in front of it (example: v1.0.1)

* Add a comment above USES "# Python 2.6-2.7,3.4+" to reflect the actual versions supported (which USES=python alone does not make clear). This will make it easier for us in the future to limit the supported versions to those that actually work.

* If the port is 'concurrent safe', that is, both Python 2.x version and Python 3.x version install all uniquely named files meaning they don't conflict (see `make makeplist` output to get a list), then add 'concurrent' to USE_PYTHON to mark the port concurrent safe

Please also confirm that this port passes QA (portlint, poudriere, etc). For more information see: https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/testing.html
Comment 2 Rick Miller 2017-06-07 17:00:58 UTC
Created attachment 183305 [details]
Diff to add py-sis-python to FreeBSD Ports
Comment 3 Rick Miller 2017-06-07 17:01:13 UTC
* The port directory is renamed to py-sis-python as this is what it's entitled in the GitHub repository.
* "python" is added to CATEGORIES
* Implemented MASTERSITES through USE_GITHUB and GH_*
* Added a comment indicating which version of Python are supported
* Added "concurrent" to USE_PYTHON

Package built via Poudriere successfully and portlint returns 0 failures, 0 warnings.

New diff -- entitled py-sis-python.diff -- is attached.
Comment 4 Kubilay Kocak freebsd_committer freebsd_triage 2017-06-07 23:58:55 UTC
(In reply to Rick Miller from comment #3)

Thank you for the update Rick

Regarding naming, Python ports must be named after their PyPI/CHEESESHOP name, in this packages case: sispy. (PORTNAME=sispy, py-sispy port directory).

Even for packages not registered with PyPI (say those with only github), names should be considered carefully to avoid actual or even potential future conflicts. 

In these cases it is highly recommended to ask the author/upstream to at least register a name (whether or not its the same as the github repository name), whether or not they actually upload any files or not, so that we can use the name and it is reserved for that projects exclusive use.

See Also: https://wiki.freebsd.org/Python/PortsPolicy
Comment 5 Rick Miller 2017-06-08 12:20:18 UTC
Thanks, Kubilay!  I was not aware of the policy regarding Python Ports.  Thanks for the link.  A new patch is attached with PORTNAME= sispy and port directory is py-sispy in accordance with the policy.
Comment 6 Rick Miller 2017-06-08 12:21:25 UTC
Created attachment 183328 [details]
Add databases/py-sispy to Ports
Comment 7 Kubilay Kocak freebsd_committer freebsd_triage 2017-06-08 12:54:49 UTC
GH_TAGNAME shouldn't be necessary with the correct PORTVERSION + DISTVERSIONPREFIX (as they appear to be).

Also, sort USE_PYTHON values :)
Comment 8 Rick Miller 2017-06-08 13:12:47 UTC
Created attachment 183329 [details]
Add databases/py-sispy to Ports
Comment 9 Rick Miller 2017-06-08 13:13:29 UTC
GH_TAGNAME removed, USE_PYTHON args sorted
Comment 10 commit-hook freebsd_committer freebsd_triage 2017-07-12 19:09:01 UTC
A commit references this bug:

Author: swills
Date: Wed Jul 12 19:07:59 UTC 2017
New revision: 445600
URL: https://svnweb.freebsd.org/changeset/ports/445600

Log:
  databases/py-sispy: create port

  Client library for interacting with the SIS RESTful API

  WWW: https://pypi.python.org/pypi/sispy

  PR:		219823
  Submitted by:	Rick Miller <vmiller@hostileadmin.com>

Changes:
  head/databases/Makefile
  head/databases/py-sispy/
  head/databases/py-sispy/Makefile
  head/databases/py-sispy/distinfo
  head/databases/py-sispy/pkg-descr
Comment 11 Steve Wills freebsd_committer freebsd_triage 2017-07-12 19:11:57 UTC
Committed, thanks!