Skip to content
Snippets Groups Projects
Commit fc9ce163 authored by Robert Greschke's avatar Robert Greschke
Browse files

Should be all ready for Py2 and 3. BaleAddr code not in this version. Will be later.

parent 9deb47a3
No related branches found
No related tags found
No related merge requests found
Pipeline #506 passed with stage
in 2 minutes and 19 seconds
......@@ -4,8 +4,8 @@
Contributing
============
Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.
Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.
You can contribute in many ways:
......@@ -20,44 +20,48 @@ Report bugs at https://git.passcal.nmt.edu/passoft/bline/issues.
If you are reporting a bug, please include:
* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Any details about your local setup that might be helpful in
troubleshooting.
* Detailed steps to reproduce the bug.
Fix Bugs
~~~~~~~~
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.
Look through the GitHub issues for bugs. Anything tagged with "bug"
and "help wanted" is open to whoever wants to implement it.
Implement Features
~~~~~~~~~~~~~~~~~~
Look through the GitLab issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.
Look through the GitLab issues for features. Anything tagged with
"enhancement" and "help wanted" is open to whoever wants to implement
it.
Write Documentation
~~~~~~~~~~~~~~~~~~~
bline could always use more documentation, whether as part of the
official bline docs, in docstrings, or even on the web in blog posts,
articles, and such.
Documentation/help for bline is obtained using -h or -H on the command
line. Suggestions and corrections should be sent to PASSCAL.
Submit Feedback
~~~~~~~~~~~~~~~
The best way to send feedback is to file an issue at https://git.passcal.nmt.edu/passoft/bline/issues.
The best way to send feedback is to file an issue at
https://git.passcal.nmt.edu/passoft/bline/issues.
If you are proposing a feature:
* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)
* Keep the scope as narrow as possible, to make it easier to
implement.
* Remember that this is a volunteer-driven project, and that
contributions are welcome :)
Get Started!
------------
Ready to contribute? Here's how to set up `bline` for local development.
Ready to contribute? Here's how to set up `bline` for local
development.
1. Cone the `bline` repo::
......@@ -74,7 +78,7 @@ Ready to contribute? Here's how to set up `bline` for local development.
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass the
tests::
tests:
$ python setup.py test
6. Commit your changes and push your branch to GitHub::
......@@ -88,12 +92,13 @@ Ready to contribute? Here's how to set up `bline` for local development.
Pull Request Guidelines
-----------------------
Before you submit a merge request, check that it meets these guidelines:
Before you submit a merge request, check that it meets these
guidelines:
1. The merge request should include tests.
2. If the merge request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
2. If the merge request adds functionality, the docs should be
updated. Put your new functionality into a function with a
docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7
Tips
......@@ -105,10 +110,8 @@ To run a subset of tests::
Deploying
---------
A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::
A reminder for the maintainers on how to deploy. Make sure all your
changes are committed (including an entry in HISTORY.rst). Then run::
$ git push
$ git push --tags
......@@ -2,7 +2,88 @@
History
=======
2018.135 (2018-06-07)
2016.288 (2016-10-14)
------------------
* New. No changes.
2016.355 (2016-12-20)
------------------
* Just changed some help descriptions a little.
* Added the -H "more" help.
2017.006 (2017-01-06)
------------------
* New -V command for examining offloaded files a bit more.
* Added a bit more to the -H help.
2017.012 (2017-01-12)
------------------
* Added a summary to the -V command output.
2017.020 (2017-01-20)
------------------
* Added baler time range (all of the files) to the -V summary.
* A couple little corrections to the help.
2017.024 (2017-01-24)
------------------
* Added some more -H command help.
* Made some of the status messages a little more wordy.
* Commands like -F "DT0001*" "DT0002*" did not work. Having multiple search
patterns would fail. "DT0002*" by itself, for example, would have worked.
Now it all works.
2017.026 (2017-01-26)
------------------
* Rewrote all of the command line handling stuff. There could be bugs
all over the place.
* Added the -m "A message" command.
* Added the -e [<files>] command for excluding files, but then only
offloading low sample rate files (like -o). -E offloads all files
(like -O).
2017.038 (2017-02-07)
------------------
* Prints out the current version when using the -U command.
* Put in note about using "bline.py" or "bline" in the helps.
2017.039 (2017-02-08)
------------------
* Fixed a bug in the -v command that showed up when files were missing
or not everything had been offloaded.
* Took the note back out about bline/bline.py. It will always be
bline.py.
2017.055 (2017-02-24)
------------------
* Changed the way the record size of a file is determined. It should
always be 4096 bytes for baler files, but you never know.
* Fixed it so you have to at least supply the TagID when using the
-m command.
2017.152 (2017-06-01)
------------------
* Does a simple check to see if the TagID and IPAddr are reversed.
* Does a simple check when offloading to see if previously offloaded
data files will be overwritten. It may report false alarms depending
on the command.
* Fixed a small bug in the -F command.
2017.163 (2017-06-12)
------------------
* Lists the command line being executed so it gets into the log.
2018.071 (2018-03-12)
------------------
* Small bug in the 'check for updates' section.
2018.135 (2018-06-07)
------------------
* First release on new build system.
2019.064 (2019-03-05)
------------------
* Converted for Python 2 or 3.
* Added -vl command that lists the files that have not been fully
offloaded from the baler. -v just shows how many there are.
* Does not yet contain BaleAddr replacement code.
......@@ -2,18 +2,20 @@
bline
=====
Download data from Baler14.
Offloads data from Baler 14's.
* Free software: GNU General Public License v3 (GPLv3)
Features
--------
* TODO
* A command line interface program that enables offloading data from
Quanterra Baler 14's, and provides a bit of QC to ensure all of the
offloaded files have been received and are not badly corrupted.
* BaleAddr-like functionality to assign IP address to balers will be
added in the future.
Credits
-------
......
This diff is collapsed.
[bumpversion]
current_version = 2018.135
current_version = 2019.064
commit = True
tag = True
......
......@@ -51,6 +51,6 @@ setup(
packages=find_packages(include=['bline']),
test_suite='tests',
url='https://git.passcal.nmt.edu/passoft/bline',
version='2018.135',
version='2019.064',
zip_safe=False,
)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment