diff mbox series

[3/3] Add Pipfile and README.md

Message ID 20211026141445.85452-3-johannes.schrimpf@blueye.no
State Accepted
Headers show
Series [1/3] Rename swupdate-client.py to swupdate_client.py | expand

Commit Message

Johannes Schrimpf Oct. 26, 2021, 2:14 p.m. UTC
Signed-off-by: Johannes Schrimpf <johannes.schrimpf@blueye.no>
---
 examples/client/Pipfile   | 13 +++++++++++
 examples/client/README.md | 47 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 examples/client/Pipfile
 create mode 100644 examples/client/README.md

Comments

Stefano Babic Oct. 28, 2021, 10:52 a.m. UTC | #1
Hi Johannes,

On 26.10.21 16:14, Johannes Schrimpf wrote:
> Signed-off-by: Johannes Schrimpf <johannes.schrimpf@blueye.no>
> ---
>   examples/client/Pipfile   | 13 +++++++++++
>   examples/client/README.md | 47 +++++++++++++++++++++++++++++++++++++++
>   2 files changed, 60 insertions(+)
>   create mode 100644 examples/client/Pipfile
>   create mode 100644 examples/client/README.md
> 

I applied them, but I get now that project is not anymore REUSE 
compliant because these two new files have no copyright and license 
information.

Tool was already licensed with GPL-2.0, these two files should be also 
with the same license. Can you fix it ?

Regards,
Stefano

> diff --git a/examples/client/Pipfile b/examples/client/Pipfile
> new file mode 100644
> index 0000000..a237601
> --- /dev/null
> +++ b/examples/client/Pipfile
> @@ -0,0 +1,13 @@
> +[[source]]
> +url = "https://pypi.org/simple"
> +verify_ssl = true
> +name = "pypi"
> +
> +[packages]
> +websockets = "*"
> +requests = "*"
> +
> +[dev-packages]
> +
> +[requires]
> +python_version = "3.9"
> diff --git a/examples/client/README.md b/examples/client/README.md
> new file mode 100644
> index 0000000..b6e5d32
> --- /dev/null
> +++ b/examples/client/README.md
> @@ -0,0 +1,47 @@
> +## Install dependencies
> +
> +### apt
> +```
> +sudo apt update
> +sudo apt install python3-websockets python3-requests
> +```
> +
> +### pip
> +```
> +pip install websockets requests
> +```
> +
> +### pipenv
> +```
> +pipenv install
> +```
> +
> +## Usage
> +
> +### apt/pip
> +```
> +./swupdate_client.py <path-to-swu> <host_name> [port]
> +```
> +
> +### pipenv
> +```
> +pipenv run ./swupdate_client.py <path-to-swu> <host_name> [port]
> +```
> +
> +
> +## Development
> +### Import from another python program
> +```
> +from swupdate_client import SWUpdater
> +
> +updater = SWUpdater("path-to-swu", "host-name")
> +if updater.update():
> +    print("Update successful!")
> +else:
> +    print("Update failed!")
> +```
> +
> +### Formatting
> +```
> +black swupdate_client.py
> +```
> \ No newline at end of file
>
Johannes Schrimpf Oct. 29, 2021, 8:30 a.m. UTC | #2
Hi Stefano,

I sent patches with license information and also added a .gitignore and .flake8. I also updated the py file to use the SPDX copyright format. Please ignore the first two patches since I forgot to sign them off.

Best regards,
Johannes

/
Lead Systems Integration Engineer
Johannes Schrimpf, Ph.D

www.blueyerobotics.com<http://www.blueyerobotics.com/>
Maker of underwater drones 




On 28 Oct 2021, at 12:52, Stefano Babic <sbabic@denx.de<mailto:sbabic@denx.de>> wrote:

Hi Johannes,

On 26.10.21 16:14, Johannes Schrimpf wrote:
Signed-off-by: Johannes Schrimpf <johannes.schrimpf@blueye.no<mailto:johannes.schrimpf@blueye.no>>
---
 examples/client/Pipfile   | 13 +++++++++++
 examples/client/README.md | 47 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 examples/client/Pipfile
 create mode 100644 examples/client/README.md

I applied them, but I get now that project is not anymore REUSE compliant because these two new files have no copyright and license information.

Tool was already licensed with GPL-2.0, these two files should be also with the same license. Can you fix it ?

Regards,
Stefano

diff --git a/examples/client/Pipfile b/examples/client/Pipfile
new file mode 100644
index 0000000..a237601
--- /dev/null
+++ b/examples/client/Pipfile
@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+websockets = "*"
+requests = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.9"
diff --git a/examples/client/README.md b/examples/client/README.md
new file mode 100644
index 0000000..b6e5d32
--- /dev/null
+++ b/examples/client/README.md
@@ -0,0 +1,47 @@
+## Install dependencies
+
+### apt
+```
+sudo apt update
+sudo apt install python3-websockets python3-requests
+```
+
+### pip
+```
+pip install websockets requests
+```
+
+### pipenv
+```
+pipenv install
+```
+
+## Usage
+
+### apt/pip
+```
+./swupdate_client.py <path-to-swu> <host_name> [port]
+```
+
+### pipenv
+```
+pipenv run ./swupdate_client.py <path-to-swu> <host_name> [port]
+```
+
+
+## Development
+### Import from another python program
+```
+from swupdate_client import SWUpdater
+
+updater = SWUpdater("path-to-swu", "host-name")
+if updater.update():
+    print("Update successful!")
+else:
+    print("Update failed!")
+```
+
+### Formatting
+```
+black swupdate_client.py
+```
\ No newline at end of file


--
=====================================================================
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic@denx.de<mailto:sbabic@denx.de>
=====================================================================
Stefano Babic Oct. 29, 2021, 8:40 a.m. UTC | #3
Hi Johannes,

On 29.10.21 10:30, Johannes Schrimpf wrote:
> Hi Stefano,
> 
> I sent patches with license information and also added a .gitignore and 
> .flake8. I also updated the py file to use the SPDX copyright format. 
> Please ignore the first two patches since I forgot to sign them off.
> 

Thanks, both applied to -master !

Best regards,
Stefano

> Best regards,
> Johannes
> 
> /
> Lead Systems Integration Engineer
> */Johannes Schrimpf/**/, Ph.D/*
> *_www.blueyerobotics.com <http://www.blueyerobotics.com/>_*
> /Maker of underwater drones /
> 
> 
> 
> 
>> On 28 Oct 2021, at 12:52, Stefano Babic <sbabic@denx.de 
>> <mailto:sbabic@denx.de>> wrote:
>>
>> Hi Johannes,
>>
>> On 26.10.21 16:14, Johannes Schrimpf wrote:
>>> Signed-off-by: Johannes Schrimpf <johannes.schrimpf@blueye.no 
>>> <mailto:johannes.schrimpf@blueye.no>>
>>> ---
>>>  examples/client/Pipfile   | 13 +++++++++++
>>>  examples/client/README.md | 47 +++++++++++++++++++++++++++++++++++++++
>>>  2 files changed, 60 insertions(+)
>>>  create mode 100644 examples/client/Pipfile
>>>  create mode 100644 examples/client/README.md
>>
>> I applied them, but I get now that project is not anymore REUSE 
>> compliant because these two new files have no copyright and license 
>> information.
>>
>> Tool was already licensed with GPL-2.0, these two files should be also 
>> with the same license. Can you fix it ?
>>
>> Regards,
>> Stefano
>>
>>> diff --git a/examples/client/Pipfile b/examples/client/Pipfile
>>> new file mode 100644
>>> index 0000000..a237601
>>> --- /dev/null
>>> +++ b/examples/client/Pipfile
>>> @@ -0,0 +1,13 @@
>>> +[[source]]
>>> +url = "https://pypi.org/simple <https://pypi.org/simple>"
>>> +verify_ssl = true
>>> +name = "pypi"
>>> +
>>> +[packages]
>>> +websockets = "*"
>>> +requests = "*"
>>> +
>>> +[dev-packages]
>>> +
>>> +[requires]
>>> +python_version = "3.9"
>>> diff --git a/examples/client/README.md b/examples/client/README.md
>>> new file mode 100644
>>> index 0000000..b6e5d32
>>> --- /dev/null
>>> +++ b/examples/client/README.md
>>> @@ -0,0 +1,47 @@
>>> +## Install dependencies
>>> +
>>> +### apt
>>> +```
>>> +sudo apt update
>>> +sudo apt install python3-websockets python3-requests
>>> +```
>>> +
>>> +### pip
>>> +```
>>> +pip install websockets requests
>>> +```
>>> +
>>> +### pipenv
>>> +```
>>> +pipenv install
>>> +```
>>> +
>>> +## Usage
>>> +
>>> +### apt/pip
>>> +```
>>> +./swupdate_client.py <path-to-swu> <host_name> [port]
>>> +```
>>> +
>>> +### pipenv
>>> +```
>>> +pipenv run ./swupdate_client.py <path-to-swu> <host_name> [port]
>>> +```
>>> +
>>> +
>>> +## Development
>>> +### Import from another python program
>>> +```
>>> +from swupdate_client import SWUpdater
>>> +
>>> +updater = SWUpdater("path-to-swu", "host-name")
>>> +if updater.update():
>>> +    print("Update successful!")
>>> +else:
>>> +    print("Update failed!")
>>> +```
>>> +
>>> +### Formatting
>>> +```
>>> +black swupdate_client.py
>>> +```
>>> \ No newline at end of file
>>
>>
>> -- 
>> =====================================================================
>> DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
>> HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
>> Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic@denx.de 
>> <mailto:sbabic@denx.de>
>> =====================================================================
> 
> -- 
> You received this message because you are subscribed to the Google 
> Groups "swupdate" group.
> To unsubscribe from this group and stop receiving emails from it, send 
> an email to swupdate+unsubscribe@googlegroups.com 
> <mailto:swupdate+unsubscribe@googlegroups.com>.
> To view this discussion on the web visit 
> https://groups.google.com/d/msgid/swupdate/208D664C-9D06-4DEA-8E5F-A3064BC3A7E5%40blueye.no 
> <https://groups.google.com/d/msgid/swupdate/208D664C-9D06-4DEA-8E5F-A3064BC3A7E5%40blueye.no?utm_medium=email&utm_source=footer>.
diff mbox series

Patch

diff --git a/examples/client/Pipfile b/examples/client/Pipfile
new file mode 100644
index 0000000..a237601
--- /dev/null
+++ b/examples/client/Pipfile
@@ -0,0 +1,13 @@ 
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+websockets = "*"
+requests = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.9"
diff --git a/examples/client/README.md b/examples/client/README.md
new file mode 100644
index 0000000..b6e5d32
--- /dev/null
+++ b/examples/client/README.md
@@ -0,0 +1,47 @@ 
+## Install dependencies
+
+### apt
+```
+sudo apt update
+sudo apt install python3-websockets python3-requests
+```
+
+### pip
+```
+pip install websockets requests
+```
+
+### pipenv
+```
+pipenv install
+```
+
+## Usage
+
+### apt/pip
+```
+./swupdate_client.py <path-to-swu> <host_name> [port]
+```
+
+### pipenv
+```
+pipenv run ./swupdate_client.py <path-to-swu> <host_name> [port]
+```
+
+
+## Development
+### Import from another python program
+```
+from swupdate_client import SWUpdater
+
+updater = SWUpdater("path-to-swu", "host-name")
+if updater.update():
+    print("Update successful!")
+else:
+    print("Update failed!")
+```
+
+### Formatting
+```
+black swupdate_client.py
+```
\ No newline at end of file