Giter VIP home page Giter VIP logo

pelican-data-files's People

Contributors

alexandry-augustin avatar lucasvanhaaren avatar s1syphos avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

pelican-data-files's Issues

Watch `data` directory for auto-reloading on changes

Hey there,
title says it all, maybe I overlooked something, but right now Pelican does not pick up changes in data files.

Before I can do something about this, I need a pointer to Pelican's internals / plugin API where to change that ๐Ÿ•บ

Cheers,
S1SYPHOS

Improve CLI by providing defaults

Check if THEME is filled in pelicanconf.py.
If true, THEME value become the default for fetch param.

It avoids mentioning the theme when there is a great chance that it is the one we want.

Provide usage samples

Provide samples for both themes and standalone websites usages.

โ„น๏ธ For now, orbelican was like a sample but I think it's better to have sample in the same repo to update both at time.

Add support for TOML

TOML (Tom's Obvious Minimal Language) is a "config file format for humans". It is readable, unambiguous, and has a standardised format. It is also "designed to map unambiguously to a hash table". As such, it is a good choice for creating configuration or data files. Python 3.11 will release a TOML parser in the standard library.

Add contribution help

Add some contribution help (CONTRIBUTING.md, developer docs, ...) in order to follow open-source best practices and allow for new comers to be onboard the project smoothly and ease contributing.


  • apply community standards
  • detailed installation instructions
  • detailed pelican generation instructions
  • how to build a theme with
  • how to contribute in
  • how it works under the hood

Duplicate check

Hey there,
for my next project I'm thinking about using your plugin - going through its code, I noticed line 75 in generators.py: TODO check for duplicates (eg: profile.json and profile.yaml). I want to contribute to your plugin, and this seems an easy target ๐Ÿ˜€ In case of a duplicate, would you .. 1. log error and exit or 2. prefer one over the other - and if so, preferring by modified time seems reasonable, no?

What do you think?

Cheers
S1SYPHOS

Bootstrap CI-CD

Bootstrap CI-CD with features:

  • automated testing (load files from all supported formats)
  • automated package release (build and push package to PyPi โš ๏ธ BUT NEED MANUAL ACTION)

Fix `tasks.py`

Some features are broken in tasks.py because of the wrong path :

PKG_NAME = "data-files" must become PKG_NAME = "data_files"

And the fact that version tagging is not automated, block twine tasks while uploading new version of package :

  • add a bump_version task before twin upload
  • OR add automated testing via github workflow and review version tagging

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.