Commit Graph

152 Commits

Author SHA1 Message Date
Radoslav Georgiev
9c5d8d1172
Link to Styleguide-Example for code examples 2021-11-22 12:03:03 +02:00
Radoslav Georgiev
4b993b8b19
Add a brief section about more ideas 2021-11-22 11:28:57 +02:00
Radoslav Georgiev
ff7c4ceb7b
Rewording 2021-11-22 10:55:33 +02:00
Radoslav Georgiev
9d59ad0495
Small rewording 2021-11-21 18:04:08 +02:00
Radoslav Georgiev
0aa2c23dc2
Add more 2021-11-21 18:03:00 +02:00
Radoslav Georgiev
85bca3199a
Start initial errors & exceptions rework 2021-11-20 18:01:28 +02:00
Radoslav Georgiev
7cd9d321fc
Update TOC 2021-11-17 14:39:11 +02:00
Radoslav Georgiev
5424ce3681
Reiterate again 2021-11-17 14:38:48 +02:00
Radoslav Georgiev
4a5a6e3604
Expand section for advanced serialization 2021-11-16 17:26:51 +02:00
Radoslav Georgiev
f200a06334
Change ModelSerializer to Serializer in examples 2021-11-16 17:09:44 +02:00
Radoslav Georgiev
ea5ee0f047
Reiterate over the initial APIs & Serializers paragraphs 2021-11-16 17:05:31 +02:00
Radoslav Georgiev
ad51865d25
Fix name of selectors 2021-09-25 19:27:15 +03:00
Radoslav Georgiev
7886bfa432
Highlight important rules of thumb 2021-09-25 19:26:23 +03:00
Radoslav Georgiev
ce05847710
Add section about testing in Services
- Remove examples for testing services / selectors from the `Testing` section
2021-09-25 19:24:54 +03:00
Radoslav Georgiev
10eaba3319
Add a diagram for the service layer 2021-09-25 19:10:54 +03:00
Radoslav Georgiev
96db6f42f2
Add new section - Modules 2021-09-19 20:19:16 +03:00
Radoslav Georgiev
199a5d698d
Move selectors as a sub-section to services 2021-09-19 20:03:47 +03:00
Radoslav Georgiev
c7ba1be8bb
Reword the naming convention section 2021-09-19 19:50:18 +03:00
Radoslav Georgiev
61f6eea6db
Reword the initial services section 2021-09-19 19:46:45 +03:00
Radoslav Georgiev
782175597a
Add an example for validation via constraints 2021-09-19 16:38:50 +03:00
Radoslav Georgiev
969a1642ce
Link a couple of articles on constraint examples 2021-09-16 17:35:57 +03:00
Radoslav Georgiev
40615d099b
Clear the initial paragraphs 2021-09-16 17:23:36 +03:00
Radoslav Georgiev
096476e36a
Use some_app instead of education 2021-09-16 17:16:39 +03:00
Radoslav Georgiev
8f7ce514fd
Iterate over models 2021-09-16 17:10:28 +03:00
Radoslav Georgiev
81e8cd0519
Improve on the initial sections 2021-09-16 15:36:31 +03:00
Radoslav Georgiev
c63b60ff7d
Add a note about Celery schedule objects 2021-09-16 14:13:39 +03:00
Radoslav Georgiev
f4dbf98c1b
Remove random python files & update location to Styleguide-Example 2021-08-13 17:26:35 +03:00
[Ar][Te]m.[Be][Rn][At]skyy
efa43dcdde
Fixed minor errors in README.md 2021-01-19 13:03:52 +02:00
Radoslav Georgiev
60591dd412 Extend the example with filtering + pagination 2020-10-25 12:33:47 +02:00
Radoslav Georgiev
f166c79785 Replace the list API example with one from Styleguide-Example project 2020-10-25 12:14:03 +02:00
Radoslav Georgiev
d3fbe72bcb
Merge pull request #51 from HackSoftware/add-note-about-circular-imports
Add subsection for circular import issues between tasks & services
2020-10-18 19:18:29 +03:00
wencakisa
f313464dbd Do not use both blank=True & null=True when unnecessary 2020-10-16 13:17:27 +03:00
Storm Heg
a8b7d54122
Fix typo in README.md
exmaple should be example.
2020-08-28 12:52:15 +02:00
Storm Heg
c2b9733085
Fix typo in README.md
acheive should be achieve.
2020-08-27 22:20:28 +02:00
Radoslav Georgiev
792ff9c056 Add a quick section about mypy / type annotations 2020-08-16 22:38:55 +03:00
Radoslav Georgiev
e268fb5b00
Add link to Styleguide-Example 2020-07-07 10:08:03 +03:00
Ventsislav Tashev
1a77336e4f Add subsection for circular import issues between tasks & services 2020-06-23 13:43:58 +03:00
Ventsislav Tashev
5a735ff6d6 Add logo to README 2020-03-15 19:14:23 +02:00
Radoslav Georgiev
fbb6de01ea Improve wording, fix typos 2020-01-19 15:31:43 +02:00
Radoslav Georgiev
f2e237765c Add section about error formatting
- Include a bunch of things for `utils.py`
2020-01-19 15:26:46 +02:00
Radoslav Georgiev
55e135436d Rename ExceptionHandlerMixin to ApiErrorsMixin 2020-01-19 14:52:51 +02:00
Radoslav Georgiev
ca0728a8fe
Merge pull request #35 from HackSoftware/naming-conventions
Naming conventions
2019-12-02 11:50:33 +02:00
Radoslav Georgiev
9c6bf84825 Add TOC for naming conventions 2019-12-02 11:50:11 +02:00
Radoslav Georgiev
dd6ffdd50d Add naming convention for APIs 2019-11-30 12:44:37 +02:00
Radoslav Georgiev
8d3fb415de Add naming convention secitons for services/selectors 2019-11-30 12:39:16 +02:00
wencakisa
f7a7f94e0b Added missing __init__.py files in tests folder structure 2019-11-12 15:25:32 +02:00
Radoslav Georgiev
47a0f26d06 Split imports for readability 2019-11-03 12:30:56 +02:00
Radoslav Georgiev
aa3bb6c9d1
Apply suggestions from code review
Co-Authored-By: Ventsislav Tashev <wencakisa@gmail.com>
2019-11-03 12:30:28 +02:00
Radoslav Georgiev
57cbdc7ce0 Finishing touches 2019-11-03 12:00:25 +02:00
Radoslav Georgiev
72110d6c35 Add section about periodic tasks 2019-11-03 11:58:07 +02:00
Radoslav Georgiev
b9c741b15a Add several paragraphs for more complex Celery scenarios 2019-11-03 11:47:56 +02:00
Radoslav Georgiev
94ea1e92a8 Add subsetion for structure 2019-11-03 11:40:54 +02:00
Radoslav Georgiev
c679538eb5 Add initial section for Celery 2019-11-03 11:26:13 +02:00
Ventsislav Tashev
ed6bb5a5df
Merge pull request #29 from HackSoftware/readme-enhancements
README enhancements
2019-10-29 21:08:42 +02:00
Ventsislav Tashev
6242a29975 Minor word replacements 2019-10-29 20:56:38 +02:00
Ventsislav Tashev
f5ea212aee Fixed minor typos 2019-10-29 20:56:09 +02:00
Ventsislav Tashev
da4f6675a0 Added reference links for mypy & faker libraries 2019-10-29 20:54:49 +02:00
Radoslav Georgiev
3c40f63aca Add a note about Django constraints for custom validation 2019-10-27 17:23:28 +02:00
Radoslav Georgiev
0b802c94a3 Add one more paragraph for splitting urls 2019-10-27 17:00:51 +02:00
Radoslav Georgiev
94c04c1cee Introduce basic urls section 2019-10-27 16:57:34 +02:00
Ventsislav Tashev
cbd7f61941 Fixed spacing and tabulation (PEP8) 2019-10-27 16:02:55 +02:00
Ventsislav Tashev
29c15708af Replaced odin importss with project 2019-10-27 16:02:23 +02:00
Ventsislav Tashev
945c664dc1
Merge pull request #25 from HackSoftware/fix-serializers-in-api-views
Fixed serializers signature in List & Detail APIs section
2019-10-27 15:54:07 +02:00
Ventsislav Tashev
91b9d4c72d Added information about exceptions that are handled by default from DRF 2019-10-27 15:43:17 +02:00
Ventsislav Tashev
7459031e1c Removed trailing whitespaces 2019-10-27 10:29:49 +02:00
Ventsislav Tashev
efa24c19db Fixed List & Detail API serializer signatures 2019-10-27 10:29:13 +02:00
Radoslav Georgiev
e63afc33f2 Reword the cookiecutter section 2019-10-26 11:19:12 +03:00
Radoslav Georgiev
2271f32cad Remove Odin from examples, since the project is deprecated 2019-10-26 11:08:00 +03:00
Ivo Donchev
16c4f89cbf Fix README typos (ticket - https://github.com/HackSoftware/Django-Styleguide/issues/11) 2019-08-19 16:23:37 +03:00
Radoslav Georgiev
a218428ab7 Remove empty space from TOC 2019-01-21 16:33:38 +02:00
Radoslav Georgiev
7832288bf8 Rename types.py to queryset_type.py 2019-01-21 16:30:47 +02:00
Radoslav Georgiev
3ed7934117 Update TOC with testing selectors section 2019-01-21 16:00:05 +02:00
Radoslav Georgiev
a1ef1c1347 Add section for Testing selectors 2019-01-21 15:57:22 +02:00
Radoslav Georgiev
8fdf1a118d Update TOC with new section structure 2019-01-20 17:19:24 +02:00
Radoslav Georgiev
e986d86608 Move example code to its own section 2019-01-20 17:18:08 +02:00
Radoslav Georgiev
7b8155e7b1 Add types.py with QuerySetType implementation 2019-01-20 17:10:43 +02:00
Radoslav Georgiev
7f2d665292 Update TOC with testing/services 2019-01-20 17:07:53 +02:00
Radoslav Georgiev
714dc42fe1 Update examples for service tests.
Add more code examples.
2019-01-20 17:05:22 +02:00
Radoslav Georgiev
9c0d6107a1 Add section for services tests 2019-01-04 17:16:01 +02:00
Radoslav Georgiev
60b649fc31 Add initial testing section with naming convetion 2019-01-04 16:07:01 +02:00
Radoslav Georgiev
83cdd847ec
Merge pull request #4 from HackSoftware/exceptions
Init some text about exceptions in services
2019-01-04 15:38:01 +02:00
Radoslav Georgiev
b29cc49545 Small tweaks in wording 2018-12-28 19:28:10 +02:00
Radoslav Georgiev
5105e53b7a Move code samples to utils.py 2018-12-28 19:24:43 +02:00
Radoslav Georgiev
ffaf960cde Expand the section on exceptions 2018-12-28 19:22:00 +02:00
Radoslav Georgiev
04b19ba0af Add exception handling to TOC 2018-12-28 18:28:42 +02:00
Ivaylo Bachvarof
6a3acf757b Feedback reflected 2018-11-18 11:47:03 +02:00
Radoslav Georgiev
809e6b3b52 Add Examples to TOC 2018-08-19 15:35:31 +03:00
Radoslav Georgiev
90d8540b6a Add link to the system that we are using for examples.
- Fix a typo along the way
2018-08-19 15:34:01 +03:00
Radoslav Georgiev
d68e304c6b Add Cookie Cutter to TOC 2018-08-19 15:27:18 +03:00
Radoslav Georgiev
fced551c3a Add section about cookiecutter 2018-08-19 15:25:19 +03:00
Radoslav Georgiev
8455c7d1d0 Add example code for CourseFactory 2018-08-13 16:02:55 +03:00
Radoslav Georgiev
e03a0c0910 Add example test for custom model validation 2018-08-13 15:49:42 +03:00
Radoslav Georgiev
8e52937316 Add section about models 2018-08-13 15:27:32 +03:00
Ivaylo Bachvarof
2495712b90 Init some text about exceptions in services 2018-08-08 18:01:30 +03:00
Radoslav Georgiev
4c051ea802 Use markdow-toc to generate a table of contents 2018-07-31 14:43:38 +03:00
Radoslav Georgiev
8b02f8d8f2 Add Inspiration paragraph 2018-07-31 14:33:27 +03:00
Radoslav Georgiev
d7bd7f7913 Add basic section for APIs 2018-07-26 12:39:31 +03:00
Radoslav Georgiev
ea27adcbb7 Add basic section for selectors 2018-07-26 12:29:16 +03:00
Radoslav Georgiev
da0e32da5e Add point for where to put services 2018-07-26 12:23:59 +03:00
Radoslav Georgiev
aebf4511ff Add section with basic service explanation 2018-07-26 12:07:52 +03:00