generalpackager 0.5.2

Tools to interface GitHub, PyPI, NPM and local modules / repos. Used for generating files to keep projects dry and synced. Tailored for my general packages.

generalpackager

Tools to interface GitHub, PyPI, NPM and local modules / repos. Used for generating files to keep projects dry and synced. Tailored for my general packages.

Contents

generalpackager
├─ Installation
├─ Information
├─ Attributes
├─ Contributions
└─ Todo

Installation

Command	generallibrary	generalfile	pandas	gitpython	pygithub	requests	pyinstaller	coverage
pip install generalpackager	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Information

Package	Ver	Latest Release	Python	Platform	Lvl	Todo	Cover
generalpackager	0.5.2	2022-09-08 21:28 CEST	3.8, 3.9, 3.10	Windows, Ubuntu	3	16	66.6 %

Attributes

Module: generalpackager
├─ Class: GitHub
│  ├─ Class: GitHub
│  ├─ Class: LocalModule
│  ├─ Class: LocalRepo
│  ├─ Class: Packager
│  ├─ Class: PyPI
│  ├─ Method: api_url (Untested)
│  ├─ Method: download
│  ├─ Method: exists
│  ├─ Method: get_description
│  ├─ Method: get_owners_packages
│  ├─ Method: get_topics
│  ├─ Method: get_website
│  ├─ Property: git_clone_command
│  ├─ Property: pip_install_command
│  ├─ Method: request_kwargs
│  ├─ Method: set_description
│  ├─ Method: set_topics
│  ├─ Method: set_website
│  ├─ Property: ssh_url (Untested)
│  └─ Property: url
├─ Class: LocalModule
│  ├─ Class: GitHub
│  ├─ Class: LocalModule
│  ├─ Class: LocalRepo
│  ├─ Class: Packager
│  ├─ Class: PyPI
│  ├─ Method: exists
│  ├─ Method: get_all_local_modules
│  ├─ Method: get_dependants
│  ├─ Method: get_dependencies
│  ├─ Property: module
│  ├─ Property: objInfo
│  └─ Property: path
├─ Class: LocalRepo
│  ├─ Class: GitHub
│  ├─ Class: LocalModule
│  ├─ Class: LocalRepo
│  ├─ Class: Packager
│  ├─ Class: PyPI
│  ├─ Class: Targets
│  ├─ Method: exists
│  ├─ Method: format_file
│  ├─ Method: get_examples_path (Untested)
│  ├─ Method: get_exeproduct_path
│  ├─ Method: get_exetarget_path
│  ├─ Method: get_generate_path
│  ├─ Method: get_git_exclude_path
│  ├─ Method: get_git_ignore_path
│  ├─ Method: get_index_js_path
│  ├─ Method: get_init_path
│  ├─ Method: get_license_path
│  ├─ Method: get_manifest_path
│  ├─ Method: get_metadata_path
│  ├─ Method: get_npm_ignore_path
│  ├─ Method: get_org_readme_path
│  ├─ Method: get_package_json_path
│  ├─ Method: get_package_paths_gen
│  ├─ Method: get_pre_commit_hook_path (Untested)
│  ├─ Method: get_randomtesting_path
│  ├─ Method: get_readme_path
│  ├─ Method: get_setup_path
│  ├─ Method: get_test_js_path
│  ├─ Method: get_test_path
│  ├─ Method: get_test_paths
│  ├─ Method: get_test_template_path
│  ├─ Method: get_workflow_path
│  ├─ Method: git_changed_files
│  ├─ Property: gitpython_repo (Untested)
│  ├─ Method: is_django
│  ├─ Method: is_exe
│  ├─ Method: is_node
│  ├─ Method: is_python
│  ├─ Property: metadata
│  ├─ Method: metadata_exists
│  ├─ Method: repo_exists
│  ├─ Property: target
│  ├─ Method: targetted
│  └─ Method: text_in_tests
├─ Class: LocalRepo_Node
├─ Class: LocalRepo_Python
│  ├─ Method: get_python_exe_path (Untested)
│  ├─ Method: get_venv_path
│  └─ Method: unittest
├─ Class: Packager
│  ├─ Class: GitHub
│  ├─ Class: LocalModule
│  ├─ Class: LocalRepo
│  ├─ Class: Packager
│  ├─ Class: Packages
│  │  └─ Method: all_packages
│  ├─ Class: PyPI
│  ├─ Class: Targets
│  ├─ Method: all_files_by_relative_path
│  ├─ Method: commit_and_push
│  ├─ Method: compare_local_to_github
│  ├─ Method: compare_local_to_pypi
│  ├─ Method: create_blank_locally_python
│  ├─ Method: create_github_repo (Untested)
│  ├─ Method: create_master_branch (Untested)
│  ├─ Method: enable_vcs_operations (Untested)
│  ├─ Method: file_by_relative_path
│  ├─ Property: file_secret_readme
│  ├─ Property: files
│  ├─ Method: filter_relative_filenames
│  ├─ Method: general_bumped_set
│  ├─ Method: general_changed_dict
│  ├─ Method: generate_generate
│  ├─ Method: generate_git_exclude
│  ├─ Method: generate_index_js
│  ├─ Method: generate_init
│  ├─ Method: generate_license
│  ├─ Method: generate_localfiles
│  ├─ Method: generate_manifest
│  ├─ Method: generate_npm_ignore
│  ├─ Method: generate_package_json
│  ├─ Method: generate_personal_readme
│  ├─ Method: generate_pre_commit (Untested)
│  ├─ Method: generate_randomtesting
│  ├─ Method: generate_readme
│  ├─ Method: generate_setup
│  ├─ Method: generate_test_node
│  ├─ Method: generate_test_python
│  ├─ Method: generate_workflow
│  ├─ Method: get_attributes_markdown
│  ├─ Method: get_badges_dict
│  ├─ Method: get_classifiers
│  ├─ Method: get_contributions_markdown (Untested)
│  ├─ Method: get_dependants
│  ├─ Method: get_dependencies
│  ├─ Method: get_description_markdown
│  ├─ Method: get_examples_markdown (Untested)
│  ├─ Method: get_footnote_markdown
│  ├─ Method: get_information_markdown
│  ├─ Method: get_installation_markdown
│  ├─ Method: get_latest_release
│  ├─ Method: get_new_packager
│  ├─ Method: get_ordered_packagers
│  ├─ Method: get_owners_package_names
│  ├─ Method: get_todos
│  ├─ Method: get_todos_markdown
│  ├─ Method: get_topics
│  ├─ Method: get_untested_objInfo_dict
│  ├─ Property: github
│  ├─ Method: github_available
│  ├─ Method: github_link
│  ├─ Method: github_link_path_line
│  ├─ Method: if_publish_bump (Untested)
│  ├─ Method: if_publish_publish (Untested)
│  ├─ Method: is_bumped
│  ├─ Method: is_django
│  ├─ Method: is_exe
│  ├─ Method: is_general
│  ├─ Method: is_node
│  ├─ Method: is_python
│  ├─ Property: localmodule
│  ├─ Method: localmodule_available
│  ├─ Property: localrepo
│  ├─ Method: localrepo_available
│  ├─ Method: name_is_general
│  ├─ Method: new_clean_environment (Untested)
│  ├─ Method: packagers_from_packages (Untested)
│  ├─ Property: pypi
│  ├─ Method: pypi_available
│  ├─ Method: relative_path_is_aesthetic
│  ├─ Method: reserve_name (Untested)
│  ├─ Method: run_ordered_methods
│  ├─ Property: simple_name
│  ├─ Method: summary_packagers
│  ├─ Method: sync_github_metadata
│  ├─ Property: target
│  ├─ Method: upload_package_summary
│  ├─ Method: workflow_sync
│  └─ Method: workflow_unittest
└─ Class: PyPI
   ├─ Class: GitHub
   ├─ Class: LocalModule
   ├─ Class: LocalRepo
   ├─ Class: Packager
   ├─ Class: PyPI
   ├─ Method: download
   ├─ Method: exists
   ├─ Method: get_date
   ├─ Method: get_owners_packages
   ├─ Method: get_tarball_url
   ├─ Method: get_version
   └─ Property: url

Contributions

Issue-creation and discussion is most welcome!

Pull requests are not wanted, please discuss with me before investing any time.

Todo

Module	Message
packager_markdown.py	Sort todos by name to decrease automatic commit changes.
packager_workflow.py	Add single job to make sure workflow is up to date.
github.py	Get and Set GitHub repo private.
metadata_python.py	Dynamic values in DataClass to remove LocalRepos and Metadatas.
localrepo_python.py	Make sure twine is installed when trying to upload to pypi.
localrepo_python.py	Look into private PyPI server where we could also do dry runs for test.
localrepo.py	Search for imports to list dependencies.
pypi.py	Move download to it's own package.
pypi.py	Find a faster fetch for latest PyPI version and datetime.
packager_github.py	commit-hook failed for auto commit "not a valid Win32 application
packager_github.py	Fetch commit sha locally before pushing, possibly generate sha before commit.
packager_github.py	Setup env vars for project.
packager_files.py	Watermark generated files to prevent mistake of thinking you can modify them directly.
packager_files.py	Generalize get_new_packager which calls recycle_clear on all attributes.
packager_files.py	Fix create_blank, it overwrites current projects pip install.
packages.py	Generate Python file in generalpackager containing general packages.

^{Generated 2022-09-08 21:28 CEST for commit ce79020.}