datafest-archive

DataFestArchive is a Python package designed to generate the DataFestArchive website from past versions of DataFest

Installation

pip install datafest-archive

Usage

DataFestArchive is a Python package designed to generate the DataFestArchive website from past versions of DataFest

Usage:

$ datafest-archive [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• project-call: Reads the spreadsheet and imports the data...
• website: Create pages of projects and people...

datafest-archive main

datafest-archive project-call

Reads the spreadsheet and imports the data into the database (sqlite3).

Usage:

$ datafest-archive project-call [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• import-data

datafest-archive project-call import-data

Usage:

$ datafest-archive project-call import-data [OPTIONS] SPREADSHEET_PATH DATABASE_FILE

Arguments:

• SPREADSHEET_PATH: [required]
• DATABASE_FILE: [required]

Options:

• --help: Show this message and exit.

datafest-archive website

Create pages of projects and people (students and advisors) from the database (sqlite3) using wowchemy-hugo-academic.

Usage:

$ datafest-archive website [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• create

datafest-archive website create

Usage:

$ datafest-archive website create [OPTIONS] PATH WEBSITE_OUTPUT_DIRECTORY

Arguments:

• PATH: [required]
• WEBSITE_OUTPUT_DIRECTORY: [required]

Options:

• --help: Show this message and exit.

datafest-archive is a command line tool that can be used to generate the DataFestArchive website from past versions of DataFest.

Development documentation

Refer to README-dev.md for development documentation.

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

List of labels and corresponding titles

You can update it in release-drafter.yml.

GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

📃 Citation

@misc{datafest-archive,
  author = {ckids-datafirst},
  title = {DataFestArchive is a Python package designed to generate the DataFestArchive website from past versions of DataFest},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/ckids-datafirst/archive}}
}

Credits

This project was generated with python-package-template