Skip to content

Commit

Permalink
Merge pull request #1 from JordanWelsman/develop
Browse files Browse the repository at this point in the history
To-do list complete. Merging now.
  • Loading branch information
JordanWelsman authored Mar 12, 2023
2 parents 45039d3 + 97d971c commit e8b1f1b
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# MacOS
.DS_Store

# Python
.venv/

# Package
test.py

# Setuptools
build/
dist/
openxml.egg-info/
**/__pycache__/
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# openxml

An open-source XML generator and parser.
54 changes: 54 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Module imports
from setuptools import setup

# Arguments
version = "0.0.0" # update __init__.py
python_version = ">=3.10"

# Long description from README.md
with open("README.md", "r") as fh:
long_description = fh.read()

# openxml package data
py_modules = []

# Run setup function
setup(
name='openxml',
version=version,
description='An open-source XML generator and parser.',
license='MIT',
long_description=long_description,
long_description_content_type='text/markdown',
author='Jordan Welsman',
author_email='jordan.welsman@outlook.com',
url='https://pypi.org/project/openxml/',
download_url='https://github.com/JordanWelsman/openxml/tags',
classifiers=[
'Development Status :: 1 - Planning',
'Intended Audience :: Developers',
'Intended Audience :: Education',
'Intended Audience :: Science/Research',
'License :: OSI Approved :: MIT License',
'Topic :: Education',
'Topic :: Scientific/Engineering',
'Topic :: Software Development',
'Topic :: Software Development :: Interpreters',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: Libraries :: Python Modules',
'Topic :: Utilities',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12"
],
package_data = {
'openxml': py_modules
},
python_requires=python_version,
install_requires = [
"jutl"
],
keywords='python, xml, modular, parsing, interpreting, exporting, importing'
)
23 changes: 23 additions & 0 deletions unbuild
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/bin/sh

# openxml Unbuild Script
# To be used to delete the directories & files created by `python setup.py bdist_wheel`.

# Author : Jordan Welsman
# Copyright : Jordan Welsman

echo "You are about to delete files & folders from openxml."
echo "These files are crucial to the ability to install and import openxml."
read -p "Do you want to continue? [Y/n]: "

if [[ $REPLY =~ ^[Yy]$ ]]
then
rm -rf build # remove build directory if exists
rm -rf dist # remove distribution directory if exists
find . -name __pycache__ -type d -print0|xargs -0 rm -r -- # remove all pycache directories
find . -name .pytest_cache -type d -print0|xargs -0 rm -r -- # remove all pytest cache directories
find . -name openxml.egg-info -type d -print0|xargs -0 rm -r -- # remove all egg-info directories
echo "Project successfully unbuilt."
else
echo "Operation aborted."
fi

0 comments on commit e8b1f1b

Please sign in to comment.