autoset_pwd
https://app.codecov.io/gh/libranet/autoset-pwd
autoset-pwd
Automatically add the $PWD-directory to the PWD_DIR-environment variable
via sitecustomize-entrypoint.
How does it work?
We register the autoset_pdw.entrypoint()-function to the sitecustomize-module that is installed by the
sitecustomize-entrypoints-package.
The registered function will look up os.getcwd() in your current working directory and
set it as PWD_DIR-environment variable.
Installation
Install via pip:
> bin/pip install autoset-pwd
Or add to your poetry-based project:
> poetry add autoset-pwd
Validate & Usage
After installing this package there is nothing left to do explicitly.
We can validate that the plugin work correctly by starting a python-session and checking the PWD_DIR-environment-variable:
> bin/python
>>> import os
>>> print(os.getcwd())
"<path-to-your-current-dir>"
print(os.getenv(”PwD_DIR”)) “
”
Registered sitecustomize-entrypoint
The autoset_pwd-function is registered as a sitecustomize-entrypoint in our pyproject.toml_:
[tool.poetry.plugins]
[tool.poetry.plugins."sitecustomize"]
autoset_pwd = "autoset_pwd:entrypoint"
Sitecustomize and all its registered entrypoints will be executed at the start of every python-process. For more information, please see sitecustomize-entrypoints
Compatibility
autoset-pwd works on Python 3.8+, including PyPy3. Tested until Python 3.11,
Notable dependencies
Changelog
All notable changes to this project will be documented in this file.
Unreleased (YYYY-MM-DD)
Package created by [Wouter Vanden Hove wouter@libranet.eu]
Security Policy
Supported Versions
Use this section to tell people about which versions of your project are currently being supported with security updates.
| Version | Supported | | ——- | —————— | | 0.x | :white_check_mark: | | 1.0.x | :white_check_mark: |
Reporting a Vulnerability
This project follows a 90 day disclosure timeline.
To report a security issue, please an email security@libranet.eu with
a description of the issue
the steps you took to create the issue,
affected versions
and if known, mitigations for the issue
Our team will acknowledge receiving your email within 3 working days.
MIT License
Copyright (c) 2023 Libranet.eu.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Contributors
Special thanks for all the people who have helped on this project so far.
Append your name if you have contributed to this package. We use anti-chronological ordering (oldest on top).
How to contribute
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
Development environment setup
Proceed to describe how to setup local development environment. e.g:
To set up a development environment, please follow these steps:
Clone the repo
git clone https://github.com/libranet/autoset-pwd
Run make install
make install
Issues and feature requests
You’ve found a bug in the source code, a mistake in the documentation or maybe you’d like a new feature? Take a look at GitHub Discussions to see if it’s already being discussed.
You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive – your issue may have already been addressed.
Please try to create bug reports that are:
Reproducible. Include steps to reproduce the problem.
Specific. Include as much detail as possible: which version, what environment, etc.
Unique. Do not duplicate existing opened issues.
Scoped to a Single Bug. One bug per report.
Even better: Submit a pull request with a fix or new feature!
How to submit a Pull Request
Search our repository for open or closed Pull Requests that relate to your submission. You don’t want to duplicate effort.
Fork the project
Create your feature branch (
git checkout -b feat/amazing_feature)Commit your changes (
git commit -m 'feat: add amazing_feature') autoset-pwd uses conventional commits, so please follow the specification in your commit messages.Push to the branch (
git push origin feat/amazing_feature)
Contributor Covenant Code of Conduct
Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Our Standards
Examples of behavior that contributes to a positive environment for our community include:
Demonstrating empathy and kindness toward other people
Being respectful of differing opinions, viewpoints, and experiences
Giving and gracefully accepting constructive feedback
Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
The use of sexualized language or imagery, and sexual attention or advances of any kind
Trolling, insulting or derogatory comments, and personal or political attacks
Public or private harassment
Publishing others’ private information, such as a physical or email address, without their explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting
Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at security@libranet.eu. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
1. Correction
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
2. Warning
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
3. Temporary Ban
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
4. Permanent Ban
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
Attribution
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
autoset_pwd
autoset_pwd.__init__.
Package Contents
Functions
Set $PWD ans environment-variable. |
|
|
Return the current working directory. |
Attributes
- autoset_pwd.__version__ = '1.0'
- autoset_pwd.__copyright__ = 'Copyright 2023 Libranet.'
- autoset_pwd.__license__ = 'MIT License'
- autoset_pwd.entrypoint()
Set $PWD ans environment-variable.
- Return type:
None
- autoset_pwd.get_cwd()
Return the current working directory.
- Return type:
pathlib.Path