diapolo10 / iplib3 Goto Github PK

Is your feature request related to a problem? Please describe.
It would be good to know how much of the codebase is being tested. Bonus points for a nice badge!

Describe the solution you'd like
Adding support for Coveralls in the project and its CI/CD GitHub Actions workflow.

Describe alternatives you've considered
None, though this isn't a high-priority issue.

The project is currently lacking a clear goal, and I want to achieve some specific level of usefulness before calling this the first official full release. Ideas, feature requests, bug fixes and defining the final interface will be the key points.

Hey,

first of all: very nice package and idea :-)

I was looking at the tests and I notice that you just have unit tests and not integration and/or acceptance tests.

About the unit tests. There is a thing that can be done better and it is parametrisation. For instance, in a test you test multiple test cases using assert. This is not optimal. It would be better to have a script with the test cases and one with the tests, and use pytest parametrisation.

If you want I could do it. I'm interested in understanding the package better, and this is a good opportunity to look deeply into your code and doing something good ;-)

let me know

I'm curious why you did not use or even extend the standard ipaddress module.
It has some cool features too. You could do great magic! For example creating a MulticastIPAddress automatically.

Technically a pure IP address has no port information. So an IP address with port should instead of "IPv4" be named Endpoint, IPv4Endpoint or similar.

An address with subnet length should also represent a specific class. Speaking of subnet masks, the most difficult and helpful feature would be calculating subnets. First, last address, etc.

But storing an IP address, a subnet length and a port in one object feels odd. Where's the use case? Where do ports and subnet lengths meet? Interface configurations don't have ports. And when you use ports you don't care for the subnet.
Except let me call it SubnetService and I'm thinking of a DHCP server listening on a specific port. But then you should consider multiple ports.

I would not ask these questions if this project was pure Python learning. I made silly or unuseful stuff too. Just for fun and for learning. I barely complete my projects until today. But your project is already on PyPI so it should be solid in a way.

Don't get me wrong. Don't want to criticise you. Your OOP implementation is quite good and I did not find any obvious bugs.

At present, the critical parts of the library have decent unit test coverage (not that it shows because Coveralls integration is still missing), but more should be added. Furthermore the library could use some integration testing.

The current state of the project's documentation isn't great - everything is in the source code and README and lacks details.