barbacbd / nautical Goto Github PK

Implement the .../units module in go

Move to a more modern/faster web crawler. Scrapy looks to be the way to go here. Beautiful soup worked well for a bit, but the results appear to be inconsistent. Find more information on scrapy.

Add a new file in nautical for release information

__version __ = ...
__author __ = ...

These can then be used as attributes in setup.cfg like
version = attr: nautical.release.version

Include doc strings in release about nautical

NCEI should and will be moved into its own library. Deprecate the module in this project.

There are several sources of tide information online. Provide this information based on latitude and longitude values and time.

Add the extension to use this module in javascript

Document how/when CI tests are run for all instances of the project.

Implement the .../location module in go

Run a static code analyzer over the code base and fix any errors/warnings. The same SCA tool should be added to the CI Tests on build. Add a badge to the README to get the SCA output.

Utilize mocking in python to create mocks for unit tests involving the NCEI module.We should make no external calls during unit tests.

Remove the haversine functions from the location/util.py. We can use the haversine module.

Currently, CI tests when file changes occur in a certain directory. New tests need to be added for GO. These should only be run when the pkg has changed.

• Open a new request to document how/when CI is run.

Function found here. Release after this is added will completely remove the function.

Implement the .../io module in go

Update This function to provide the users with the ability to determine if their point lies within a complex or simple geometry. Accept a set of ordered points in the clockwise direction. If there are just two points, create a bounding box using the min, min to max, max (essentially creating a square) and check that way. Less than 2 points returns False.

Create the unit tests to test this functionality.

Implement the .../sea_state module in go

After #2 is completed, a new release and version bump should occur. Then remove the module.

Implement the .../cache module in go

Add in golint and gotest scripts to the /scripts directory.

Implement the .../log module in go.

Add the in range function here to the point class. Keep the static functions, just call the function of P1.

Add in unit tests

Add the ability to call this library in C/C++

On release add an action to automatically generate the documentation and push it up where github can host it.

This should really be pushed to its own project. Deprecate this software so that can be used in another project. The deprecation will prepare for the deletion.

Implement the .../noaa/buoy module in go.

Read in a yaml file in the same format as the template file in the project. See ncei/token.yaml for more information. The function should accept a single parameter, the path to the file. The parameter will default to the default yaml file. If the default is used, log a warning. The file should be a yaml file with a single line: token: {{ TOKEN }}

Utilize mocking for unit tests with the web module. We should be making no external calls when creating tests.

This requires #50 to be merged and a new version to be created

Run flake8 or another linter over the code base and fix all issues.

Add the ability to read currents information.

Currently the buoy description is taken from the KML page. Parse the description (it is CDATA) and add this to the Buoy object.

Add a system cache that enables the user to save look up time if enough time has not passed.

The cache should also allow the user to provide the original objects and set the past data.

Implement the .../noaa/ncei module in go.

Add examples for using the IO module (add how to utilize the buoy objects) as well as the NCEI module.

These docs should reside in /users/docs.

The NCEI docs will contain the NCEI examples.
The other examples can be added to a new file called Nautical.md

New user docs need to be generated for all GO packing.

Implement the .../time module in Go.

In nautical/io/sources the pm.name field is interpreted incorrectly when the name can be an integer. The leading zeros are dropped. As of right now there is a hack fix where an int field will be zformatted with 5 0's. We need to try to interpret this data as a string no matter what.

Should I look into redesigning tests so that they are a part of the package.

• Exclude them in the manifest and any setup information
• Pytest would be run from home
• Consideration: Go tests are a part of the main source.

Wait for this issue to be resolved. Make sure that the issue is in a release then remove the function completely.

There are currently no test for parameters in the NCEI tests.

1. List of valid params
2. Single Param
3. Single Param - not correct type -> Raises AttributeError
4. List of Params where one is a bad type -> Raises AttributeError