sloria / tinynetrc Goto Github PK

View Code? Open in Web Editor NEW

13.0 3.0 7.0 58 KB

Read and write .netrc files in Python

License: MIT License

Python 100.00%

netrc posix python python-3 python-2 ftp

tinynetrc's Introduction

tinynetrc

Read and write .netrc files in Python.

tinynetrc uses the netrc module from the standard library under the hood and adds a few improvements:

Adds write functionality.
Fixes a std lib bug with formatting a .netrc file.*
Parses .netrc into dictionary values rather than tuples.

*This bug is fixed in newer versions of Python.

Get it now

pip install tinynetrc

tinynetrc supports Python >= 2.7 or >= 3.5.

Usage

from tinynetrc import Netrc

netrc = Netrc()  # parse ~/.netrc
# Get credentials
netrc['api.heroku.com']['login']
netrc['api.heroku.com']['password']

# Modify an existing entry
netrc['api.heroku.com']['password'] = 'newpassword'
netrc.save()  # writes to ~/.netrc

# Add a new entry
netrc['surge.surge.sh'] = {
    'login': '[email protected]',
    'password': 'secret'
}
netrc.save()

# Removing an new entry
del netrc['surge.surge.sh']
netrc.save()

You can also use Netrc as a context manager, which will automatically save ~/.netrc.

from tinynetrc import Netrc
with Netrc() as netrc:
    netrc['api.heroku.com']['password'] = 'newpassword'
    assert netrc.is_dirty is True
# saved!

License

MIT licensed. See the bundled LICENSE file for more details.

tinynetrc's People

Contributors

Stargazers

Watchers

Forkers

melakf2 xytan0056 tirkarthi joooeey pombredanne mplew-is

tinynetrc's Issues

Deprecation warning regarding `collections.abc` in python 3.9

python3.8/site-packages/tinynetrc-1.3.0-py3.8.egg/tinynetrc.py:5: 

DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated since Python 3.3, and in 3.9 it will stop working 

from collections import MutableMapping, defaultdict

Create .netrc file

There doesn't seem to be any way to create a new .netrc file when none already exists. What's the recommendation?

One user-side workaround is to create an empty .netrc if one doesn't already exist, but that's pretty ugly - we also have to replicate the internal default-file stuff you do in your __init__ method:

# When .netrc exists:
with tinynetrc.Netrc() as netrc:
    netrc[host] = {'login': username, 'password': password}

# When .netrc might not exist:
import os
fname = os.path.join(os.path.expanduser('~'), '.netrc')
with open(fname, 'a'):
    pass

with tinynetrc.Netrc(fname) as netrc:
    netrc[host] = {'login': username, 'password': password}

Dependabot couldn't authenticate with https://pypi.python.org/simple/

Dependabot couldn't authenticate with https://pypi.python.org/simple/.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

==================================== ERRORS ====================================
___________________ ERROR collecting tests/test_siteship.py ____________________
.tox/py36/lib/python3.6/site-packages/tinynetrc.py:38: in __init__
    file = os.path.join(os.environ['HOME'], ".netrc")
.tox/py36/lib/python3.6/os.py:669: in __getitem__
    raise KeyError(key) from None
E   KeyError: 'HOME'
During handling of the above exception, another exception occurred:
tests/test_siteship.py:11: in <module>
    from siteship import cli
siteship/cli.py:14: in <module>
    netrc = Netrc()
.tox/py36/lib/python3.6/site-packages/tinynetrc.py:40: in __init__
    raise OSError("Could not find .netrc: $HOME is not set")
E   OSError: Could not find .netrc: $HOME is not set

https://travis-ci.org/siteship/siteship-cli

Context manager API?

Using a context manager to manage opening and saving of the netrc might be a more idiomatic API.

with Netrc() as netrc:
    netrc['surge.surge.sh'] = {
        'login': '[email protected]',
        'password': 'secret'
    }