Feature/logger setup #15
Conversation
…tion and to run a unit test
…added some documentation
…itrary file will work.
…-any arbitrary file will work
There was a problem hiding this comment.
I know that we wanted the ability to easily configure what log level to see (perhaps from a settings file, as you note in the PR). Could this be added to this PR? I think adding .log files to the .gitignore could be straightforward too -- I can do that right after this code review.
Additionally, I think some documentation in a README or something giving a basic understanding of logbook would be helpful. That way, it would be straightforward for someone to look at that documentation and instantly use the logbook module. For example, I'm not quite sure on first glance how the application stack or thread stack works.
I like that the test cases help document how the logbook is used though -- definitely helpful, and good coverage to make sure that the logbook module we're relying on will be somewhat safe!
Good work! 👍 😄
| @@ -0,0 +1,6 @@ | |||
| <?xml version="1.0" encoding="UTF-8"?> | |||
There was a problem hiding this comment.
This file seems to have sneaked in from an IDE configuration folder, and should be removed.
| @@ -0,0 +1,16 @@ | |||
| # Installation of Logbook | |||
There was a problem hiding this comment.
I would list this as a requirement in requirements.txt found in the root-level directory.
| @@ -0,0 +1,21 @@ | |||
|
|
|||
| # make sure to sync these up with _speedups.pyx | |||
There was a problem hiding this comment.
What is _speedups.pyx?
| @@ -0,0 +1,24 @@ | |||
| from logbook import Logger | |||
| import unittest | |||
| #from ../Logger import Logger | |||
There was a problem hiding this comment.
I'd remove this line just to keep things clean, unless it's kept in here for some reason.
| self._log_handler.pop_thread() | ||
| self._logger = None | ||
|
|
||
| #@classmethod |
There was a problem hiding this comment.
I'd also remove these commented lines if they aren't serving a purpose.
| @@ -0,0 +1,16 @@ | |||
| # Installation of Logbook | |||
There was a problem hiding this comment.
I think I would rename this to README.md and make it a broader document. Logbook Setup could be a section, but we could also include other sections for usage, to-do's, etc.
…tion and to run a unit test
…added some documentation
…itrary file will work.
…-any arbitrary file will work
…Aerospace/Aerocube into feature/logger-setup
|
How's progress on this going, Angel? I believe the story asked for a wrapper class to simplify our own calls to any logging functionality. Have you gotten around to implementing a wrapper class yet? |
…cube into feature/logger-setup
I have implemented a logging system.
I have two unit tests displaying how to use the logger.
Features
Installation
Future
.logfiles to the .gitignore.propertiesfile)Aside: I propose we make smaller pull requests.