Skip to content

Commit

Permalink
Remove trailing spaces and version bump (#35)
Browse files Browse the repository at this point in the history 
Remove trailing spaces and version bump

Bump version for PyPI

Refactor pushPath_compress and handle trailing '/' logic and remove all trailing spaces in source

Update copyright

Make sure no spurious pudb.set_trace() are hanging about...
  • Loading branch information
@rudolphpienaar
rudolphpienaar committed Jul 20, 2020
1 parent 08a13e4 commit c93a507
Show file tree
Hide file tree
Showing 4 changed files with 241 additions and 190 deletions.
26 changes: 13 additions & 13 deletions README.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
##################
pfurl - v2.2.2.2
pfurl - v2.2.4.0
##################

.. image:: https://badge.fury.io/py/pfurl.svg
Expand Down Expand Up @@ -85,7 +85,7 @@ The easiest option however, is to just use the ``fnndsc/pfurl`` container image.
.. code-block:: bash
docker pull fnndsc/pfurl
and then run

.. code-block:: bash
Expand Down Expand Up @@ -114,7 +114,7 @@ For the most up-to-date usage of ``pfurl``, consult the `pfurl wiki page <https:
[--verb <RESTVERB>]
The REST verb to use for the remote service.

[--http <IP>:<port>]
[--http <IP>:<port>]
The address of the remote service.

[--httpProxy [<proto>://]<IP>[:<port>]]
Expand All @@ -129,12 +129,12 @@ For the most up-to-date usage of ``pfurl``, consult the `pfurl wiki page <https:
[--jsonwrapper <outerMsgJSONwrapper>]
An optional outer wrapper for the JSON payload.

[--quiet]
[--quiet]
If specified, only echo the final JSON payload returned
from remote server.

[--raw]
If specified, do not wrap return data from remote call in a
If specified, do not wrap return data from remote call in a
JSON wrapper.

[--oneShot]
Expand All @@ -145,29 +145,29 @@ For the most up-to-date usage of ``pfurl``, consult the `pfurl wiki page <https:
[--man <help>]
Provide detailed help on various topics.

[-x|--desc]
[-x|--desc]
Provide an overview help page.

[-y|--synopsis]
Provide a synopsis help summary.

[--content-type <type>]
[--content-type <type>]
Curl content-type descriptor.
[--jsonpprintindent <indent>]

[--jsonpprintindent <indent>]
If specified, print return JSON payload from remote service using
<indent> indentation.

[--httpResponseBodyParse]
[--httpResponseBodyParse]
If specified, interpret the return payload as encapsulated in an
http response.

[--unverifiedCerts]
[--unverifiedCerts]
If specified, allows transmission of https requests with self signed SSL
certificates.

[--authToken <token>]
A token to transmit with an http request. Note, you if you set an
A token to transmit with an http request. Note, you if you set an
--authToken, then you should NOT also set an --auth.

[--auth <user>:<passwd>]
Expand Down Expand Up @@ -202,7 +202,7 @@ Say 'hello' to a ``pfcon`` service listening on the localhost at port 5005:
"askAbout": "sysinfo",
"echoBack": "Hi there!"
}
}' --quiet --jsonpprintindent 4
}' --quiet --jsonpprintindent 4
and print response "prettily" using an indent of 4.

Expand Down
60 changes: 30 additions & 30 deletions bin/pfurl
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python3
#
# (c) 2017-2019 Fetal-Neonatal Neuroimaging & Developmental Science Center
# (c) 2017-2020 Fetal-Neonatal Neuroimaging & Developmental Science Center
# Boston Children's Hospital
#
# http://childrenshospital.org/FNNDSC/
Expand All @@ -24,17 +24,17 @@ str_defIP = [l for l in ([ip for ip in socket.gethostbyname_ex(socket.gethostn
str_defPort = '5055'

str_name = 'pfurl'
str_version = "2.2.2.2"
str_version = "2.2.4.0"
str_desc = Colors.CYAN + """
__ _
__ _
/ _| | |
_ __ | |_ _ _ _ __| |
| '_ \| _| | | | '__| |
| |_) | | | |_| | | | |
| .__/|_| \__,_|_| |_|
| |
|_|
| |
|_|
Process-File-over-URL
Expand All @@ -43,33 +43,33 @@ str_desc = Colors.CYAN + """
-- version """ + \
Colors.YELLOW + str_version + Colors.CYAN + """ --
'pfurl' sends REST conforming commands and data to remote services,
similar in some ways to the well-known CLI tool, 'curl' or the Python
'pfurl' sends REST conforming commands and data to remote services,
similar in some ways to the well-known CLI tool, 'curl' or the Python
tool, 'httpie'.
'pfurl' not only sends curl type payloads, but can also zip/unzip
'pfurl' not only sends curl type payloads, but can also zip/unzip
entire directories of files for transmission and reception.
'pfurl' is designed to be part of the ChRIS framework but can also be
used in similar use cases to 'curl' or 'httpie'.
""" + \
Colors.RED + """
+---------------------------------------------------------+
| Use --auth <user>:<password> and --authToken <token> |
| arguments for secure communication. |
| arguments for secure communication. |
+---------------------------------------------------------+
""" + Colors.NO_COLOUR

def synopsis(ab_shortOnly = False):
scriptName = os.path.basename(sys.argv[0])
shortSynopsis = '''
NAME
pfurl
pfurl
- curl-type http communication client.
Expand Down Expand Up @@ -109,18 +109,18 @@ def synopsis(ab_shortOnly = False):
"echoBack": "Hi there!",
"service": "host"
}
}' --quiet --jsonpprintindent 4
}' --quiet --jsonpprintindent 4
''' % str_defIP

description = '''
DESCRIPTION
`pfurl` is a communications program that sends http-type curl
data to a remote service. Although it is mostly used in the
`pfurl` is a communications program that sends http-type curl
data to a remote service. Although it is mostly used in the
"pf" family of programs and in the ChRIS suite, it can be also
used a general-purpose curl replacement.
In addition to sending JSON-formatted strings to a service,
In addition to sending JSON-formatted strings to a service,
`pfurl` can also send files and whole directories -- the latter
being a zip compression of a directory tree.
Expand All @@ -132,7 +132,7 @@ def synopsis(ab_shortOnly = False):
[--verb <RESTVERB>]
The REST verb to use for the remote service.
[--http <IP>:<port>]
[--http <IP>:<port>]
The address of the remote service.
[--httpProxy [<proto>://]<IP>[:<port>]]
Expand All @@ -150,12 +150,12 @@ def synopsis(ab_shortOnly = False):
[--jsonwrapper <outerMsgJSONwrapper>]
An optional outer wrapper for the JSON payload.
[--quiet]
[--quiet]
If specified, only echo the final JSON payload returned
from remote server.
[--raw]
If specified, do not wrap return data from remote call in a
If specified, do not wrap return data from remote call in a
JSON wrapper.
[--oneShot]
Expand All @@ -166,24 +166,24 @@ def synopsis(ab_shortOnly = False):
[--man <help>]
Provide detailed help on various topics.
[-x|--desc]
[-x|--desc]
Provide an overview help page.
[-y|--synopsis]
Provide a synopsis help summary.
[--content-type <type>]
[--content-type <type>]
Curl content-type descriptor.
[--jsonpprintindent <indent>]
[--jsonpprintindent <indent>]
If specified, print return JSON payload from remote service using
<indent> indentation.
[--httpResponseBodyParse]
[--httpResponseBodyParse]
If specified, interpret the return payload as encapsulated in an
http response.
[--unverifiedCerts]
[--unverifiedCerts]
If specified, allows transmission of https requests with self signed SSL
certificates.
Expand Down Expand Up @@ -217,7 +217,7 @@ def synopsis(ab_shortOnly = False):
"echoBack": "Hi there!",
"service": "host"
}
}' --quiet --jsonpprintindent 4
}' --quiet --jsonpprintindent 4
and print response "prettily" using an indent of 4.
Expand Down

0 comments on commit c93a507

Please sign in to comment.