Skip to content

Latest commit

 

History

History
36 lines (18 loc) · 1.48 KB

README.md

File metadata and controls

36 lines (18 loc) · 1.48 KB

gcn-classic-text-to-json

How to contribute

This package uses Poetry for packaging and Python virtual environment management. To get started:

  1. Fork and clone this repository.

  2. Install pre-commit hooks by running the following two commands:

    pip install pre-commit
    pre-commit install
    
  3. Install Poetry by following their installation instructions.

  4. Install this package and its dependencies by running the following command inside your clone of this repository:

    poetry install --all-extras
    
  5. Run the following command to launch a shell that is preconfigured with the project's virtual environment:

    poetry shell
    

How to execute package to obtain GCN Classic JSONs

The package can be executed through two methods:

  1. You can obtain all the JSONs associated with a single mission in your current working directory by running the following command:

     python3 -m gcn_classic_text_to_json.notices.{missions_name}
    
  2. Alternatively, you can obtain all JSONs associated with all missions in your current working directory by running the following command:

     python3 -m gcn_classic_text_to_json