Python Package to Generate Meetup Websites
Project description
meetlify
Python based Static Site Genrators for Meetups/Meetup Webites.
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.
-
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. -
Now execute
meetlify setup
which will setup the all folders as per your configurations. -
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.