micaeljarniac / buildurl Goto Github PK

Simple URL builder

Home Page: https://buildurl.readthedocs.io

License: MIT License

Python 100.00%

python python3 url tool url-parser url-parsing manipulating-urls url-manipulation buildurl library

buildurl's Introduction

BuildURL

Simple URL builder

Read the Docs

Installation

pip

buildurl is available on pip:

pip install buildurl

GitHub

You can also install the latest version of the code directly from GitHub:

pip install git+git://github.com/MicaelJarniac/BuildURL

Usage

For more examples, see the full documentation.

from buildurl import BuildURL

# Use the `/` operator to add a string as a path to the end of the URL, like so:
url = BuildURL("https://pypi.org")
url /= "project"
url /= "buildurl"
print(url.get)  # https://pypi.org/project/buildurl

# Or, using a list:
url = BuildURL("https://pypi.org")
url /= ["project", "buildurl"]
print(url.get)  # https://pypi.org/project/buildurl

# Use the `+` operator to add a dict as a query:
url = BuildURL("https://example.com")
url += {"testing": "true"}
url += {"fruit": "apple"}
print(url.get)  # https://example.com?testing=true&fruit=apple

# Those operations can also be done without modifying the original URL:
url = BuildURL("https://python.org")
print(url.get)  # https://python.org
print((url / "doc").get)  # https://python.org/doc
print(url.get)  # https://python.org

# To get the final URL as a string:
url = BuildURL("https://example.com")
url.get
str(url)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

More details can be found in CONTRIBUTING.

Contributors ✨

_{Micael Jarniac}
💻 📖 💡 🤔 🚧 📦 📆

⚠️

License

MIT

buildurl's People

Contributors

Stargazers

Watchers

buildurl's Issues

[FEAT] Fluent interfaces

It would be nice if methods add_path() and add_query() return self so one can easily chain calls like u.add_path('foo').add_path('bar')

Also fluent setter for trailing_slash would be helpful. E.g.:

def set_trailing_slash(self, enabled = True):
  self.trailing_slash = bool(enabled)
  return self

Add reference to furl

https://github.com/gruns/furl

I've only discovered furl after creating BuildURL.

They have a lot in common, so it's worth referencing furl as a possible alternative.

[FEAT] Using *arg resp **kwargs for add_path resp add_query

It would be convenient to be able to call methods like this:

url.add_path('foo', 'bar', 'xyz')
url.add_query(foo=1, bar=2)

Option for keeping trailing slash in path

Hello, http://www.example.com/path can be different from http://www.example.com/path/ or even might not exists at all. So it would be good to have an option to keep trailing slash.

[FEAT] trailing_slash argument to init()

E.g. url = BuildURL('example.com', trailing_slash=True) so one can set it from the beginning:)

[placeholder]

Alternatives

[placeholder]

[FEAT/BUG] Automatically convert arguments of path/query to string

Bug part: I was trying to do something like .add_path(['user', 123]) and it didn't raise an exception during the execution of the method but only when i called .get, which is imho late.
Feature request: Everything should be converted to str automatically (not raising error) or at least usual types like int, float. I think it should be user's responsibility to provide desired str output and everyone knows that resulting url is always str.

[Info] General Info

Misc. References

Creating a URL without a scheme, then adding one, results in `scheme:///url`, with 3 `/`

from buildurl import BuildURL

url = BuildURL("example.com")
url.get  # example.com
url.scheme = "https"
url.get  # https:///example.com
url.parts  # ('https', '', 'example.com', '', '')