Boxine - bx_django_utils

Various Django utility functions

Quickstart

pip install bx_django_utils

Existing stuff

Here only a simple list about existing utilities. Please take a look into the sources and tests for deeper informations.

models utilities

  • approve_workflow - Base model/admin/form classes to implement a model with draft/approve versions workflow
  • manipulate.create_or_update() - Similar to django's create_or_update() with benefits
  • timetracking.TimetrackingBaseModel() - Base model with "create" and "last update" date time

data types

test utilities

  • datetime.MockDatetimeGenerator() - Mock django timezone.now() with generic time stamps
  • html_assertion.HtmlAssertionMixin - Unittest mixin class with usefull assertments around Django test client tests
  • model_clean_assert.CleanMock() - Context manager to track if model full_clean() was called
  • users - Utilities around user/permission setup for tests
  • time.MockTimeMonotonicGenerator() - Mock time.monotonic() with generic time stamps
  • AssertQueries() - Context manager with different checks of made database queries

performance analysis

  • dbperf.query_recorder.SQLQueryRecorder - Context Manager that records SQL queries executed via the Django ORM

humanize

  • humanize.time.human_timedelta() - Converts a time duration into a friendly text representation. (X ms, sec, minutes etc.)
  • templatetags.humanize_time.human_duration() - Verbose time since template tag, e.g.: <span title="Jan. 1, 2000, noon">2.0 seconds</span>
  • filename.filename2human_name() - Convert filename to a capitalized name
  • filename.clean_filename() - Convert filename to ASCII only via slugify
  • pformat() - Better pretty-print-format using DjangoJSONEncoder with fallback to pprint.pformat()

view utilities

  • view_utils.dynamic_menu_urls.DynamicViewMenu() - Register views to build a simple menu with sections

misc

  • stacktrace.get_stacktrace() - Returns a filterable and easy-to-process stacktrace

developing

To start developing e.g.:

~$ git clone https://github.com/boxine/bx_django_utils.git
~$ cd bx_django_utils
~/bx_django_utils$ make
help                 List all commands
install-poetry       install or update poetry
install              install via poetry
update               Update the dependencies as according to the pyproject.toml file
lint                 Run code formatters and linter
fix-code-style       Fix code formatting
tox-listenvs         List all tox test environments
tox                  Run pytest via tox with all environments
tox-py36             Run pytest via tox with *python v3.6*
tox-py37             Run pytest via tox with *python v3.7*
tox-py38             Run pytest via tox with *python v3.8*
tox-py39             Run pytest via tox with *python v3.9*
pytest               Run pytest
pytest-ci            Run pytest with CI settings
publish              Release new version to PyPi
makemessages         Make and compile locales message files
start-dev-server     Start Django dev. server with the test project
clean                Remove created files from the test project (e.g.: SQlite, static files)

You can start the test project with the Django developing server, e.g.:

~/bx_django_utils$ make start-dev-server

This is a own manage command, that will create migrations files from our test app, migrate, collectstatic and create a super user if no user exists ;)

If you like to start from stretch, just delete related test project files with:

~/bx_django_utils$ make clean

...and start the test server again ;)

License

MIT. Patches welcome!

Links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (101)

7 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for ara.hayrabedian from gravatar.com ara.hayrabedian Avatar for Chiron1991 from gravatar.com Chiron1991 Avatar for cnschn from gravatar.com cnschn
+4 more Avatar for manologg from gravatar.com manologg Avatar for phihag from gravatar.com phihag Avatar for pylucid from gravatar.com pylucid Avatar for tbdaniel27 from gravatar.com tbdaniel27

Credits

Author: Jens Diemer

License

MIT License (MIT)

Requires

Python >=3.6, <4.0.0

Tags

django utilities

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bx_django_utils-1.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bx_django_utils-1-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

Details for the file bx_django_utils-1.tar.gz.

File metadata

  • Download URL: bx_django_utils-1.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for bx_django_utils-1.tar.gz
Algorithm Hash digest
SHA256 99e38f8da025046b2aa759725c84e606e5c2d94c086cafc40f6072d25ab2963d
MD5 5e2ef7ea96ccff83009fe11e2829b780
BLAKE2b-256 62446821346d25348f2b88ffb8c8458e428b0e98fbd292224e0728cb69bd5bc1

See more details on using hashes here.

File details

Details for the file bx_django_utils-1-py3-none-any.whl.

File metadata

  • Download URL: bx_django_utils-1-py3-none-any.whl
  • Upload date:
  • Size: 37.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for bx_django_utils-1-py3-none-any.whl
Algorithm Hash digest
SHA256 85982fc851d83ad652123ec85c855685b2cc4031613bf9428f09ba6b9d9f8984
MD5 fe6ceeb6c15d281d4ce20530489c8595
BLAKE2b-256 0f338960e8571f45af6d57347a020f907f26edffd8a56dc6048792210427d814

See more details on using hashes here.

Release history Release notifications | RSS feed

101

2 files

100

2 files

99

2 files

98

2 files

97

2 files

96

2 files

95

2 files

94

2 files

93

2 files

92

2 files

91

2 files

90

2 files

89

2 files

88

2 files

87

2 files

86

2 files

85

2 files

84

2 files

83

2 files

82

2 files

81

2 files

79

2 files

78

2 files

Pre-release

78rc0

2 files

77

2 files

76

2 files

75

2 files

74

2 files

72

2 files

71

2 files

70

2 files

69

2 files

68

2 files

67

2 files

66

2 files

65

2 files

64

2 files

63

2 files

62

2 files

61

2 files

60

2 files

59

2 files

58

2 files

57

2 files

56

2 files

55

2 files

54

2 files

53

2 files

52

2 files

Pre-release

52rc1

2 files

51

2 files

50

2 files

49

2 files

48

2 files

47

2 files

46

2 files

45

2 files

44

2 files

43

2 files

42

2 files

41

2 files

40

2 files

39

2 files

38

2 files

Pre-release

38rc0

2 files

37

2 files

36

2 files

35

2 files

34

2 files

33

2 files

32

2 files

31

2 files

30

2 files

29

2 files

28

2 files

27

2 files

26

2 files

25

2 files

24

2 files

23

2 files

22

2 files

21

2 files

20

2 files

19

2 files

18

2 files

17

2 files

16

2 files

15

2 files

14

2 files

13

2 files

12

2 files

11

2 files

10

2 files

9

2 files

8

2 files

7

2 files

6

2 files

5

2 files

4

2 files

3

2 files

2

2 files

This release

1 This release

2 files

Pre-release

1a0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page