https://github.com/kjczarne/metaframe
Metadata files to Pandas Dataframes
https://github.com/kjczarne/metaframe
Last synced: 3 months ago
JSON representation
Metadata files to Pandas Dataframes
- Host: GitHub
- URL: https://github.com/kjczarne/metaframe
- Owner: kjczarne
- Created: 2023-09-13T19:50:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T04:41:48.000Z (about 1 year ago)
- Last Synced: 2025-01-23T04:11:53.527Z (4 months ago)
- Language: Python
- Size: 309 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mdframe
View metadata files as a Pandas DataFrame
## Installation
1. Get [Python Poetry](https://python-poetry.org/)
2. `cd` into the root of this repository
3. Run `poetry install`
## Development
1. For development installation use `poetry install --with dev`.
2. Use `pylint` as the linter. Configuration for `pylint` is provided in `pyproject.toml`.
3. Use `unittest` to develop and run unit- and integration tests (`pytest` is a nightmare to debug in VSCode).
4. If you're adding new functionality, please write a test for it and make sure all tests are passing before submitting a pull request.
5. Keep commit messages informative. It is unacceptable to use dummy commit messages.
6. Keep commits small and commit often.
7. Document your functions using Google docstring style. Use typing annotations at the very least in function/method signatures.
> 👀 It's recommended to use VSCode debugger for development. Configurations for the debugger are provided under `.vscode/launch.json`.