Code Monkey home page Code Monkey logo

meetlify's Introduction

meetlify

Python based Static Site Genrators for Meetups/Meetup Webites.

license status pypi_version supported_python_versions

How to Use?

This package is available at pypi and you can install it with pip install meetlify command. It will also install required additional libraries/Python Packages automatically.

Using GitHub Template

We have prepard meetlify-template which is a sample template repository. Just use this template to create your own repository.

This approach is for buy and non techies who just want to host a simple meetup website. Make sure that GitHub actions are allowed to execute on your account. After successful clone, the website will automatically create/update gh_pages branch which you can link with any static hosting provider e.g. GitHub Page, Netlify, Cloudflare Pages, Vercel and others. However, this repo is optimized for hosting on Netlify.

Using Command Line Interface (CLI)

Create an empty folder on your computer or move to a desired location where you want to create the Meetup Website.

  1. Now execute meetlify init which will crate an empty configuration file (JSON) in the folder. Feel free to edit it as per your need. Content of the configuration file are self explanatory.

  2. Now execute ```meetlify setup`` which will setup the all folders as per your configurations.

  3. Now execute ```meetlify make`` which will generate full website in output folder.

Using Application Programming Interface (API)

You can embed ```meetilify`` into your existing workflow easily. Here is a sample snippet.

from pathlib import Path
from meetlify.api import Meetlify
from meetlify.utils import initialize

destination_path = Path("/home/user/Desktop/sample_webiste/")

# Now initialize configurationn file
initialize(dest_=destination_path)

# Modify newly created config.json file as per your need.
mlfy = Meetlify(dest_=destination_path) # Create Meetlify object with destination folder
mlfy.parse_meetups() # Parse meetups markdown files
mlfy.render_meetups() # Render meetups
mlfy.render_home() # Render Home Page
mlfy.render_pages() # Render Static Pages
mlfy.copy_assests() # Copy assets e.g. Favicon, Images, JS, CSS files

How to Extend ?

  • Clone or download this repository to your computer.
  • Create a virtual environment using python -m .venv venv
  • Navigate to the downloaded directory and then install all required dependencies using pip install -e .
  • Now you can open api.py file and start editing it. Feel free to extend it or even submit a pull request if you have a useful feature.

Contribute

Pull Requests, Feature Suggestions, and collaborations are welcome.

About Us

This work is a collaborative effort of PyBodensee, and SerpWings.

meetlify's People

Contributors

seowings avatar

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.